Get WhatsApp Blue Tick Verified with 10% off
WhatsApp Business API
WhatsApp Business API by Hello All
What Is Official WhatsApp Business API:
WhatsApp API is designed for medium to large companies that want to use WhatsApp with multiple Consumers. Unlike the WhatsApp Business App, WhatsApp API has no app or front-end interface and needs to be integrated into a messaging App. While businesses can get WhatsApp API access directly from Meta, the more popular way is to access it through third-party services called WhatsApp Business Solution Providers (BSPs) like Hello All.
Why Choose HELLO ALL:
Our innovative platform and grounded expertise allow businesses to offer professional customer service through WhatsApp messaging. Hello All is one of the pioneering companies in professional messenger services and is currently the leading Software-as-a-Service provider for messenger communication. Now you can easily and securely use the most popular global messaging apps WhatsApp Business API.
- This API use for Grow up your leads from WhatsApp. If you are a genuine Business owner then you can use it.
WhatsApp Channel
Session Messages
POST Session Text Message
{{Domain}}/v1/messages
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "text" ,
"text" :{
"body" : "Your Message Here"
}
}
Example Request
Session Text Message
curl
curl -- location - g '{{Domain}}/v1/messages' \
-- header 'API-KEY:' \
-- data ' {
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "text" ,
"text" :{
"body" : "Your Message Here"
}
} '
POST Session Image Message
{{Domain}}/v1/messages
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "image" ,
"image" :{
"link" : "Your Image Link Here"
}
}
Example Request
Session Image Message
curl
curl -- location - g '{{Domain}}/v1/messages' \
-- header 'API-KEY: API-Key' \
-- data ' {
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "image" ,
"image" :{
"link" : "Your Image Link Here"
}
} '
POST Session Video Message
{{Domain}}/v1/messages
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "video" ,
"video" :{
"link" : "Your Video Link Here"
}
}
Example Request
Session Video Message
curl
curl -- location - g '{{Domain}}/v1/messages' \
-- header 'API-KEY: API-Key' \
-- data ' {
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "video" ,
"video" :{
"link" : "Your Video Link Here"
}
} '
GET Session Document Message
{{Domain}}/v1/messages
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "document" ,
"document" :{
"link" : "Your Document Link Here"
"filename" : "File Name Here"
}
}
Example Request
Session Document Message
curl
curl -- location - g -- request GET '{{Domain}}/v1/messages' \
-- header 'API-KEY: API-Key' \
-- data ' {
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "document" ,
"document" :{
"link" : "Your Document Link Here" ,
"filename" : "File Name Here"
}
} '
POST Session List Message (Single Section)
{{Domain}}/v1/messages
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "interactive" ,
"interactive" : {
"type" "list" ,
"header" : {
"type" : "text" ,
"text" : "your-header-content"
} ,
"body" : {
"text" : "your-text-message-content" ,
} ,
"footer" : {
"text" : "your-footer-content" ,
} ,
"action" : {
"button" : "Button Text Comes Here" ,
"sections" :[
{
"title" : "your-section-title-content" ,
"rows" : [
{
"id" : "unique-row-identifier" ,
"title" : "row-title-content" ,
"description" : "row-description-content" ,
} ,
{
"id" : "unique-row-identifier" ,
"title" : "row-title-content" ,
"description" : "row-description-content" ,
}
]
}
]
}
}
}
Example Request
Session List Message (Single Section)
curl
curl -- location - g '{{Domain}}/v1/messages' \
-- header 'API-KEY: API-Key' \
-- data ' {
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "interactive" ,
"interactive" :{
"type" "list" ,
"header" : {
"type" : "text" ,
"text" : "your-header-content"
} ,
"body" : {
"text" : "your-text-message-content" ,
} ,
"footer" : {
"text" : "your-footer-content" ,
} ,
"action" : {
"button" : "Button Text Comes Here" ,
"sections" :[
{
"title" : "your-section-title-content" ,
"rows" : [
{
"id" : "unique-row-identifier" ,
"title" : "row-title-content" ,
"description" : "row-description-content" ,
} ,
{
"id" : "unique-row-identifier" ,
"title" : "row-title-content" ,
"description" : "row-description-content" ,
}
]
}
]
}
}
} '
POST Session List Message (Multiple Section)
{{Domain}}/v1/messages
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "interactive" ,
"interactive" : {
"type" "list" ,
"header" : {
"type" : "text" ,
"text" : "your-header-content"
} ,
"body" : {
"text" : "your-text-message-content" ,
} ,
"footer" : {
"text" : "your-footer-content" ,
} ,
"action" : {
"button" : "Button Text Comes Here" ,
"sections" :[
{
"title" : "your-section-title-content" ,
"rows" : [
{
"id" : "unique-row-identifier" ,
"title" : "row-title-content" ,
"description" : "row-description-content" ,
}
]
} ,
{
"title" : "your-section-title-content" ,
"rows" : [
{
"id" : "unique-row-identifier" ,
"title" : "row-title-content" ,
"description" : "row-description-content" ,
}
]
}
]
}
}
}
Example Request
Session List Message (Multiple Section)
curl
curl -- location - g '{{Domain}}/v1/messages' \
-- header 'API-KEY: API-Key' \
-- data ' {
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "interactive" ,
"interactive" :{
"type" "list" ,
"header" : {
"type" : "text" ,
"text" : "your-header-content"
} ,
"body" : {
"text" : "your-text-message-content" ,
} ,
"footer" : {
"text" : "your-footer-content" ,
} ,
"action" : {
"button" : "Button Text Comes Here" ,
"sections" :[
{
"title" : "your-section-title-content" ,
"rows" : [
{
"id" : "unique-row-identifier" ,
"title" : "row-title-content" ,
"description" : "row-description-content" ,
}
]
} ,
{
"title" : "your-section-title-content" ,
"rows" : [
{
"id" : "unique-row-identifier" ,
"title" : "row-title-content" ,
"description" : "row-description-content" ,
}
]
}
]
}
}
} '
POST Session Reply Button Message
{{Domain}}/v1/messages
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "interactive" ,
"interactive" : {
"type" "button" ,
# start header
"header" : {
"text" : "text" | "image" | "video" | "document" ,
"text" : "your text"
# OR
"document" : {
"link" : "the-provider-name/protocol://the-url"
"filename" : "some-file-name"
} ,
# OR
"video" : {
"link" : "the-provider-name/protocol://the-url"
}
# OR
"image" : {
"link" : "http(s)://the-url"
}
} , # end header
"body" : {
"text" : "your-text-body-content" ,
} ,
"footer" : { # optional
"text" : "your-text-footer-content" ,
} ,
"action" : {
"buttons" : [
{
"type" : "reply" ,
"reply" : {
"id" : "unique-postback-id" ,
"title" : "First Button’s Title" ,
}
} ,
{
"type" : "reply" ,
"reply" : {
"id" : "unique-postback-id" ,
"title" : "Second Button’s Title" ,
}
}
]
}
}
}
Example Request
Session Reply Button Message
curl
curl -- location - g '{{Domain}}/v1/messages' \
-- header 'API-KEY: API-Key' \
-- data ' {
"to" : "919999999999" ,
"recipient_type" : "individual" ,
"type" : "interactive" ,
"interactive" : {
"type" "button" ,
# start header
"header" : {
"text" : "text" | "image" | "video" | "document" ,
"text" : "your text"
# OR
"document" : {
"link" : "the-provider-name/protocol://the-url"
"filename" : "some-file-name"
} ,
# OR
"video" : {
"link" : "the-provider-name/protocol://the-url"
}
# OR
"image" : {
"link" : "http(s)://the-url"
}
} , # end header
"body" : {
"text" : "your-text-body-content" ,
} ,
"footer" : { # optional
"text" : "your-text-footer-content" ,
} ,
"action" : {
"buttons" : [
{
"type" : "reply" ,
"reply" : {
"id" : "unique-postback-id" ,
"title" : "First Button’s Title" ,
}
} ,
{
"type" : "reply" ,
"reply" : {
"id" : "unique-postback-id" ,
"title" : "Second Button’s Title" ,
}
}
]
}
}
}
} '
Template
POST Send Template Message
{{Domain}}/v1/messages
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"to" : "919999999999" ,
"type" : "template" ,
"template" : {
"namespace" : "your_namespace_id" ,
"language" : {
"policy" : "deterministic" ,
"code" : "en"
},
"name" : "name_here" ,
"components" : [
{
"type" : "body" ,
"parameters" : [
{
"type" : "text" ,
"text" : "text_here"
},
{
"type" : "text" ,
"text" : "text_here"
}
]
}
]
}
}
Example Request
Send Template Message
curl
curl -- location - g '{{Domain}}/v1/messages' \
-- header 'API-KEY: API Key' \
-- data ' {
"to" : "919999999999" ,
"type" : "template" ,
"template" : {
"namespace" : "your_namespace_id" ,
"language" : {
"policy" : "deterministic" ,
"code" : "en"
},
"name" : "name_here" ,
"components" : [
{
"type" : "body" ,
"parameters" : [
{
"type" : "text" ,
"text" : "text_here"
},
{
"type" : "text" ,
"text" : "text_here"
}
]
}
]
}
} '
GET Template List
{{Domain}}/v1/configs/templates?limit=10&offset=0
HEADERS
API KEY
API KEY
PARAMS
limit
10
offset
0
Example Request
Template List
curl
curl -- location - g '{{Domain}}/v1/configs/templates ?limit=10&offset=0' \
-- header 'API-KEY: API Key'
Create Template
POST Standard Template (Only Body)
{{Domain}}/v1/configs/templates
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"name" : "no_header_template" ,
"category" : "ALERT_UPDATE" ,
"language" : "en" ,
"components" :[
{
"type" : "BODY" ,
"type" : "Hello {{1}}\n\nThis is a test body {{2}}" ,
"example" : {
"body_text" :[
[
"bodyVariable1" ,
"bodyVariable2"
]
]
}
}
]
}
Example Request
Standard Template (Only Body)
curl
curl -- location - g '{{Domain}}/v1/configs/templates' \
-- header 'API-KEY: API Key' \
-- data ' {
"name" : "no_header_template" ,
"category" : "ALERT_UPDATE" ,
"language" : "en" ,
"components" :[
{
"type" : "BODY" ,
"type" : "Hello {{1}}\n\nThis is a test body{{2}}" ,
"example" : {
"body_text" :[
[
"bodyVariable1" ,
"bodyVariable2"
]
]
}
}
]
} '
POST Text Header
{{Domain}}/v1/configs/templates
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"name" : "text_header_template" ,
"category" : "ALERT_UPDATE" ,
"language" : "en" ,
"components" :[
{
"type" : "HEADER" ,
"format" : "TEXT" ,
"text" : "Text Header Can Have Only One Variable {{1}}" ,
"example" : {
"header_text" :[
"headerVariable"
]
}
},
{
"type" : "FOOTER" ,
"format" : "Footer Text" ,
},
{
"type" : "BODY" ,
"text" : "Hello {{1}}\n\nThis is a test body {{2}}" ,
"example" :{
"body_text" :[
[
"bodyVariable1" ,
"bodyVariable2"
]
]
}
},
{
"type" : "BUTTONS" ,
"buttons" :[
{
"type" : "QUICK_REPLY" ,
"text" : "Button 1" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 2" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 3" ,
}
]
}
]
}
Example Request
Text Header
curl
curl -- location - g '{{Domain}}/v1/configs/templates' \
-- header 'API-KEY: API Key' \
-- data ' {
"name" : "text_header_template" ,
"category" : "ALERT_UPDATE" ,
"language" : "en" ,
"components" :[
{
"type" : "HEADER" ,
"format" : "TEXT" ,
"text" : "Text Header Can Have Only One Variable {{1}}" ,
"example" : {
"header_text" :[
"headerVariable"
]
}
},
{
"type" : "FOOTER" ,
"format" : "Footer Text" ,
},
{
"type" : "BODY" ,
"text" : "Hello {{1}}\n\nThis is a test body {{2}}" ,
"example" :{
"body_text" :[
[
"bodyVariable1" ,
"bodyVariable2"
]
]
}
},
{
"type" : "BUTTONS" ,
"buttons" :[
{
"type" : "QUICK_REPLY" ,
"text" : "Button 1" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 2" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 3" ,
}
]
}
]
} '
POST Image Header
{{Domain}}/v1/configs/templates
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"name" : "image_header_template" ,
"category" : "ALERT_UPDATE" ,
"language" : "en" ,
"components" :[
{
"type" : "HEADER" ,
"format" : "IMAGE" ,
"example" : {
"header_handle" :[
"https://abc.com/waba/l4y50apq.jpeg"
]
}
},
{
"type" : "FOOTER" ,
"format" : "Footer Text" ,
},
{
"type" : "BODY" ,
"text" : "Hello {{1}}\n\nThis is a test body {{2}}" ,
"example" :{
"body_text" :[
[
"bodyVariable1" ,
"bodyVariable2"
]
]
}
},
{
"type" : "BUTTONS" ,
"buttons" :[
{
"type" : "QUICK_REPLY" ,
"text" : "Button 1" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 2" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 3" ,
}
]
}
]
}
Example Request
Image Header
curl
curl -- location - g '{{Domain}}/v1/configs/templates' \
-- header 'API-KEY: API Key' \
-- data ' {
"name" : "image_header_template" ,
"category" : "ALERT_UPDATE" ,
"language" : "en" ,
"components" :[
{
"type" : "HEADER" ,
"format" : "IMAGE" ,
"example" : {
"header_handle" :[
"https://abc.com/waba/l4y50apq.jpeg"
]
}
},
{
"type" : "FOOTER" ,
"format" : "Footer Text" ,
},
{
"type" : "BODY" ,
"text" : "Hello {{1}}\n\nThis is a test body {{2}}" ,
"example" :{
"body_text" :[
[
"bodyVariable1" ,
"bodyVariable2"
]
]
}
},
{
"type" : "BUTTONS" ,
"buttons" :[
{
"type" : "QUICK_REPLY" ,
"text" : "Button 1" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 2" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 3" ,
}
]
}
]
} '
POST Document Header
{{Domain}}/v1/configs/templates
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"name" : "image_header_template" ,
"category" : "ALERT_UPDATE" ,
"language" : "en" ,
"components" :[
{
"type" : "HEADER" ,
"format" : "DOCUMENT" ,
"example" : {
"header_handle" :[
"https://abc.com/waba/l2rlatc4.pdf"
]
}
},
{
"type" : "FOOTER" ,
"format" : "Footer Text" ,
},
{
"type" : "BODY" ,
"text" : "Hello {{1}}\n\nThis is a test body {{2}}" ,
"example" :{
"body_text" :[
[
"bodyVariable1" ,
"bodyVariable2"
]
]
}
},
{
"type" : "BUTTONS" ,
"buttons" :[
{
"type" : "QUICK_REPLY" ,
"text" : "Button 1" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 2" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 3" ,
}
]
}
]
}
Example Request
Document Header
curl
curl -- location - g '{{Domain}}/v1/configs/templates' \
-- header 'API-KEY: API Key' \
-- data ' {
"name" : "image_header_template" ,
"category" : "ALERT_UPDATE" ,
"language" : "en" ,
"components" :[
{
"type" : "HEADER" ,
"format" : "DOCUMENT" ,
"example" : {
"header_handle" :[
"https://abc.com/waba/l2rlatc4.pdf"
]
}
},
{
"type" : "FOOTER" ,
"format" : "Footer Text" ,
},
{
"type" : "BODY" ,
"text" : "Hello {{1}}\n\nThis is a test body {{2}}" ,
"example" :{
"body_text" :[
[
"bodyVariable1" ,
"bodyVariable2"
]
]
}
},
{
"type" : "BUTTONS" ,
"buttons" :[
{
"type" : "QUICK_REPLY" ,
"text" : "Button 1" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 2" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 3" ,
}
]
}
]
} '
POST Video Header
{{Domain}}/v1/configs/templates
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"name" : "image_header_template" ,
"category" : "ALERT_UPDATE" ,
"language" : "en" ,
"components" :[
{
"type" : "HEADER" ,
"format" : "VIDEO" ,
"example" : {
"header_handle" :[
"https://abc.com/waba/l4we1qri.mp4"
]
}
},
{
"type" : "FOOTER" ,
"format" : "Footer Text" ,
},
{
"type" : "BODY" ,
"text" : "Hello {{1}}\n\nThis is a test body {{2}}" ,
"example" :{
"body_text" :[
[
"bodyVariable1" ,
"bodyVariable2"
]
]
}
},
{
"type" : "BUTTONS" ,
"buttons" :[
{
"type" : "QUICK_REPLY" ,
"text" : "Button 1" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 2" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 3" ,
}
]
}
]
}
Example Request
Video Header
curl
curl -- location - g '{{Domain}}/v1/configs/templates' \
-- header 'API-KEY: API Key' \
-- data ' {
"name" : "image_header_template" ,
"category" : "ALERT_UPDATE" ,
"language" : "en" ,
"components" :[
{
"type" : "HEADER" ,
"format" : "VIDEO" ,
"example" : {
"header_handle" :[
"https://abc.com/waba/l4we1qri.mp4"
]
}
},
{
"type" : "FOOTER" ,
"format" : "Footer Text" ,
},
{
"type" : "BODY" ,
"text" : "Hello {{1}}\n\nThis is a test body {{2}}" ,
"example" :{
"body_text" :[
[
"bodyVariable1" ,
"bodyVariable2"
]
]
}
},
{
"type" : "BUTTONS" ,
"buttons" :[
{
"type" : "QUICK_REPLY" ,
"text" : "Button 1" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 2" ,
},
{
"type" : "QUICK_REPLY" ,
"text" : "Button 3" ,
}
]
}
]
} '
Webhook
POST Set Webhook
{{Domain}}/v1/configs/webhook?API Key=API Key
PARAMS
API KEY
API KEY
Body raw (json)
json
{
"url" : "https://example.com" ,
}
Example Request
Set Webhook
curl
curl -- location - g '{{Domain}}/v1/configs/
webhook?API%20Key=API%20Key' \
-- data ' {
"url" : "https://example.com"
} '
POST Get Webhook
{{Domain}}/v1/configs/webhook
HEADERS
Example Request
Get Webhook
curl
curl -- location - g -- request POST '{{Domain}}
/v1/configs/webhook' \
-- data ' {
"url" : "https://example.com"
} '
POST Delete Webhook
{{Domain}}/v1/configs/webhook?API Key=API Key
PARAMS
API KEY
API KEY
Body raw (json)
json
{
"url" : "https://example.com" ,
}
Example Request
Delete Webhook
curl
curl -- location - g '{{Domain}}/v1/configs/webhook' \
-- header 'API-KEY: API Key' \
-- data ' {
"url" : "https://example.com"
} '
Media
GET Retrive Media
{{Domain}}/v1/media.php?id=YOUR-MEDIA-ID-HERE
HEADERS
API KEY
API KEY
PARAMS
id
YOUR-MEDIA-ID-HERE
Example Request
Retrive Media
curl
curl -- location - g '{{Domain}}/v1/media.php?
id=YOUR-MEDIA-ID-HERE' \
-- header 'API-KEY: API Key' \
DEL Delete Media
{{Domain}}/v1/media.php?id=YOUR-MEDIA-ID-HERE
HEADERS
API KEY
API KEY
PARAMS
id
YOUR-MEDIA-ID-HERE
Example Request
Delete Media
curl
curl -- location - g -- request DELETE '{{Domain}}
/v1/media.php?id=YOUR-MEDIA-ID-HERE' \
-- header 'API-KEY: API Key' \
-- data ''
Settings
GET Phone Number Associated With WhatsApp Business API
{{Domain}}/v1/configs/phone_number
HEADERS
API KEY
API KEY
Example Request
Phone Number Associated
curl
curl -- location - g '{{Domain}}/v1/configs/
phone_number' \
-- header 'API-KEY: API Key' \
GET Get User Information
{{Domain}}/api/getuser
HEADERS
API KEY
API KEY
Example Request
Get User Information
curl
curl -- location - g '{{Domain}}/api/getuser' \
-- header 'API-KEY: API Key'
GET Get Business Profile
{{Domain}}/v1/settings/business/profile
Example Request
Get Business Profile
curl
curl -- location - g '{{Domain}}/v1/settings/business/profile'
GET Get Profile About Content
{{Domain}}/v1/settings/profile/about
Example Request
Get Profile About Content
curl
curl -- location - g '{{Domain}}/v1/settings/profile/about'
GET Get Profile Photo
{{Domain}}/v1/settings/profile/photo
HEADERS
API KEY
API KEY
Example Request
Get Profile Photo
curl
curl -- location - g '{{Domain}}/v1/settings/profile/photo' \
-- header 'API-KEY: API Key'
GET Get Profile Photo Link
{{Domain}}/v1/settings/profile/photo?format=link
HEADERS
API KEY
API KEY
PARAMS
format
link
Example Request
Get Profile Photo Link
curl
curl -- location - g '{{Domain}}/v1/settings/
profile/photo?format=link' \
-- header 'API-KEY: API Key'
PATCH Update Profile About
{{Domain}}/v1/configs/settings/business/profile
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"text" : "Profile About Here" ,
}
Example Request
Update Profile About
curl
curl -- location - g -- request PATCH '{{Domain}}/v1/configs/
settings/business/profile' \
-- header 'API-KEY: API Key' \
-- data ' {
"text" : "Profile About Here"
} '
GET Update Compliance Info ( Indian Users )
{{Domain}}/v1/settings/business/compliance_info
HEADERS
D360-API-KEY
API KEY
Body raw (json)
json
{
"entity_name" : "" ,
"entity_type" : "Private Company" ,
"customer_care_details" :{
"email" : "" ,
"landline_number" : "" ,
"mobile_number" : ""
},
"grievance_officer_details" :{
"name" : "" ,
"email" : "" ,
"landline_number" : "" ,
"mobile_number" : ""
}
}
Example Request
Update Compliance Info (Indian Users)
curl
curl -- location - g -- request GET '{{Domain}}/v1/settings/
business/compliance_info' \
-- header 'D360-API-KEY: API Key' \
-- data ' {
"entity_name" : "" ,
"entity_type" : "Private Company" ,
"customer_care_details" :{
"email" : "" ,
"landline_number" : "" ,
"mobile_number" : ""
},
"grievance_officer_details" :{
"name" : "" ,
"email" : "" ,
"landline_number" : "" ,
"mobile_number" : ""
}
} '
CRM
Custom Field Settings
GET List All Custom Field
{{Domain}}/crm/setting/custom-field
HEADERS
API KEY
API KEY
Example Request
Custom Field Settings
curl
curl -- location - g '{{Domain}}/crm/setting/custom-field' \
-- header 'API-KEY: API Key'
POST Create Custom Field
{{Domain}}/v1/messages
HEADERS
API KEY
API KEY
Body raw (json)
json
{
"name" : "CUSTOM FIELD NAME" ,
"type" : "CUSTOM FIELD TYPE" ,
"description" : "CUSTOM FIELD DESCRIPTION"
}
Example Request
Create Custom Field
curl
curl -- location - g '{{Domain}}/crm/setting/custom-field' \
-- header 'API-KEY: API-Key' \
-- data ' {
"name" : "CUSTOM FIELD NAME" ,
"type" : "CUSTOM FIELD TYPE" ,
"description" : "CUSTOM FIELD DESCRIPTION"
} '
DELETE Delete Custom Field
{{Domain}}/crm/setting/custom-field/:id
HEADERS
API KEY
API KEY
PATH VARIABLES
id
Example Request
Delete Custom Field
curl
curl -- location - g -- request DELETE '{{Domain}}
crm/setting/custom-field/:id' \
-- header 'API-KEY: API Key'
Chat Settings
GET List All Custom Field For Chat
{{Domain}}/crm/chat/setting/:chat-id/custom-field
HEADERS
API KEY
API KEY
PATH VARIABLES
chat-id
Example Request
List All Custom Field For Chat
curl
curl -- location - g '{{Domain}}/crm/chat/setting/ \
:chat-id/custom-field' \
-- header 'API-KEY: API Key'
POST Add/Update Custom Field In Chat
{{Domain}}/crm/chat/setting/:chat-id/custom-field
HEADERS
API KEY
API KEY
PATH VARIABLES
chat-id
Body raw (json)
json
{
"data" : [
{
"id" : "CUSTOM FIELD ID 1" ,
"value" : "CUSTOM FIELD VALUE 1" ,
},
{
"id" : "CUSTOM FIELD ID 2" ,
"value" : "CUSTOM FIELD VALUE 2" ,
}
]
}
Example Request
Add/Update Custom Field In Chat
curl
curl -- location - g '{{Domain}}/crm/chat/ \
setting/:chat-id/custom-field' \
-- header 'API-KEY: API Key' \
-- data ' {
"data" : [
{
"id" : "CUSTOM FIELD ID 1" ,
"value" : "CUSTOM FIELD VALUE 1" ,
},
{
"id" : "CUSTOM FIELD ID 2" ,
"value" : "CUSTOM FIELD VALUE 2" ,
}
]
} '
DELETE Delete Custom Field From Chat
{{Domain}}/crm/chat/setting/:chat-id/custom-field/:id
HEADERS
API KEY
API KEY
PATH VARIABLES
chat-id
id
Example Request
Delete Custom Field From Chat
curl
curl -- location - g -- request DELETE '{{Domain}}/crm/
chat/setting/:chat-id/custom-field/:id' \
-- header 'API-KEY: API Key'