Public
ENVIRONMENT No Environment
LAYOUT Double Column
LANGUAGE cURL – cURL
APIs
Introduction
POST Send Message
POST Send Media Message
POST Send Template Message
POST Create Contact
POST Update Contact
POST Send Interactive Message
POST Assign Team Member
POST Send Carousel Template Message
GET Contact
GET Contacts
APIs
POST
Send Message
{{apiBaseUrl}}/{{vendorUid}}/contact/send-message
AUTHORIZATION Bearer Token
{{bearerToken}}
Body raw (json)
{
// optional from phone number id is not given it will use default phone number id
"from_phone_number_id": "{{fromPhoneNumberId}}",
"phone_number": "{{phoneNumber}}",
"message_body": "your message body",
// if you want to create contact if it does not exist
"contact": {
"first_name": "Johan",
"last_name": "Doe",
"email": "johndoe@doamin.com",
"country": "india",
"language_code": "en",
"groups": "examplegroup1,examplegroup2",
"custom_fields": {
"BDay": "2025-09-04"
}
}
}
Example Request
curl –location -g ‘{{apiBaseUrl}}/{{vendorUid}}/contact/send-message’ \
–data-raw ‘{
// optional from phone number …
“from_phone_number_id”: “{{fromPhoneNumberId}}”,
“phone_number”: “{{phoneNumber}}”,
“message_body”: “your message body”,
“contact”: { “first_name”: “Johan”, … }
}’
–data-raw ‘{
// optional from phone number …
“from_phone_number_id”: “{{fromPhoneNumberId}}”,
“phone_number”: “{{phoneNumber}}”,
“message_body”: “your message body”,
“contact”: { “first_name”: “Johan”, … }
}’
Example Response
No response body – This request doesn’t return any response body
POST
Send Media Message
{{apiBaseUrl}}/{{vendorUid}}/contact/send-media-message
AUTHORIZATION Bearer Token
{{bearerToken}}
Body raw (json)
{
"from_phone_number_id": "{{fromPhoneNumberId}}",
"phone_number": "{{phoneNumber}}",
"media_type": "document",
"media_url": "https://images.pexels.com/photos/.../pexels-photo-276267.jpeg",
"caption": "your capation for image or video media types",
"file_name": "your file name for document",
"contact": {
"first_name": "Johan",
"last_name": "Doe",
"email": "johndoe@doamin.com",
"country": "india",
"language_code": "en",
"groups": "examplegroup1,examplegroup2"
}
}
Example Request
curl –location -g ‘{{apiBaseUrl}}/{{vendorUid}}/contact/send-media-message’ \
–data-raw ‘{ … }’
–data-raw ‘{ … }’
Example Response
No response body – This request doesn’t return any response body
POST
Send Template Message
{{apiBaseUrl}}/{{vendorUid}}/contact/send-template-message
→ see full JSON body in Postman collection (fields like template_name, header_image, button_0, copy_code, etc.)
{{bearerToken}}
No response body
📎 full documentation: https://documenter.getpostman.com/view/17404097/2sA35D4hpx
