Current
WhatsApp v3.0
Explore documented operations, request formats, responses, authentication, code examples, and the interactive API console.
95Operations
8Categories
3HTTP Methods
SDK Generation
Build With Your Language
Download a version-specific client package containing a reusable API client, endpoint catalogue, OpenAPI specification, dependencies, and setup instructions.
Endpoint Directory
95 Published Endpoints
Browse The API
Choose a category or search across endpoint names, paths, and descriptions.
Messages
POST
Send Text Message
/{phone_number_id}/messagesThis API is used to send the text message to the end user using the Whatsapp CDC panel.
arrow_forward
POST
Send Location Message/{phone_number_id}/messagesThis API is used to send the location message to the end user.
arrow_forward
POST
Send Image Message/{phone_number_id}/messagesThis API is used to send the image message to the end user.
arrow_forward
POST
Send Document Message/{phone_number_id}/messagesThis API is used to send the document message to the end user.
arrow_forward
POST
Send Video Message/{phone_number_id}/messagesThis API is used to send the video message to the end user.
arrow_forward
POST
Send Contact Message/{phone_number_id}/messagesThis API is used to send the contact message to the end user.
arrow_forward
POST
Send Interactive Message/{phone_number_id}/messagesThis API is used to send the interactive message to the end user.
arrow_forward
POST
Send Location Request Message/{phone_number_id}/messagesThis API is used to send the location request message to the end user.
arrow_forward
POST
Send Address Message/{phone_number_id}/messagesThis API is used to send the address message to the end user.
arrow_forward
POST
Mark message as read/{phone_number_id}/messagesThis API is used to set the status of the message id as read
arrow_forward
Payments
POST
Order details
/{phone_number_id}/messagesOrder details from the Partners API documentation.
arrow_forward
POST
Order Status/{phone_number_id}/messagesOrder Status from the Partners API documentation.
arrow_forward
POST
Payment refund/{phone_number_id}/messagesThis API is used by the business to initiate a refund for an order.
arrow_forward
GET
Get Payment Status/{phone_number_id}/payments/{payment_configuration}/{order-id}This API is used to get the payment status for the given order id using phone number id.
arrow_forward
Catalogues
POST
Single Product Catalogue
/{phone_number_id}/messagesThis API is used to send the catalogue message for a single product.
arrow_forward
POST
MultiProduct Catalogue/{phone_number_id}/messagesThis API is used to send the catalogue message for a multiple product.
arrow_forward
POST
Create Catalog Product/{catalog-id}/batchThis API is used to add a product in the given catalog id.
arrow_forward
POST
Update Catalog Product/{catalog-id}/batchThis API is used to update a product in the given catalog id.
arrow_forward
POST
Delete Catalog Product/{catalog-id}/batchThis API is used to delete a product in the given catalog id.
arrow_forward
GET
Product Catalog API/{catalog-id}/productsThis API is used to fetch the products in the given catalog id.
arrow_forward
GET
Product Catalog API/fetchcatalogIdThis API is used to fetch the catalog id for the given waba number.
arrow_forward
Templates
POST
Send Text Template Message
/{phone_number_id}/messagesThis API is used to send the text template message to the end user.
arrow_forward
POST
Send Media Template Message/{phone_number_id}/messagesThis API is used to send the media template message to the end user.
arrow_forward
POST
Send Interactive Template Message - Call to Action/{phone_number_id}/messagesThis API is used to send the interactive template message(Call to Action) to the end user.
arrow_forward
POST
Send Interactive Media Template Message - Quick Reply/{phone_number_id}/messagesThis API is used to send the interactive media template message(Quick Reply) to the end user.
arrow_forward
POST
Send Media Template Message with multiple button/{phone_number_id}/messagesThis API is used to send the image template with multiple button messages to the end user.
arrow_forward
POST
Send Media Template Message with multiple button/{phone_number_id}/messagesThis API is used to send the image template message with multiple buttons and dynamic url placeholder to the end user.
arrow_forward
POST
Send Coupon Code Template Message/{phone_number_id}/messagesThis API is used to send the coupon code template message to the end user.
arrow_forward
POST
Send MPM Template Message/{phone_number_id}/messagesThis API is used to send the multiple product template message to the end user.
arrow_forward
POST
Send Limited Time Offer Template Message/{phone_number_id}/messagesThis API is used to send the limited time offer template message to the end user.
arrow_forward
POST
Send Carousel Template Message without Body placeholder/{phone_number_id}/messagesThis API is used to send the carousel template message without the body placeholders to the end user.
arrow_forward
POST
Send Carousel Template Message with Body placeholder/{phone_number_id}/messagesThis API is used to send the carousel template message with body placeholders to the end user.
arrow_forward
POST
Text Template with Body, header, quick reply/{wabaid}/message_templatesThis API is used for creating text templates with body, header and quick reply.
arrow_forward
POST
Text Template with Body, header, footer/{wabaid}/message_templatesThis API is used for creating text templates with body, header and footer.
arrow_forward
POST
Text Template with Body, Header, Footer, Visit Website and Call to Phone/{wabaid}/message_templatesThis API is used for creating text templates with body, header,footer, Visit website and call to phone.
arrow_forward
POST
Image Template with Body, Header, Footer/{wabaid}/message_templatesThis API is used for creating image templates with body, header and footer.
arrow_forward
POST
Image Template with Body, Header, Footer, Visit Website and Call to Phone/{wabaid}/message_templatesThis API is used for creating image templates with body, header, footer, visit website and call to phone.
arrow_forward
POST
Image Template with Body, Header, Footer, Quick Reply/{wabaid}/message_templatesThis API is used for creating image templates with body, header, footer, and quick reply
arrow_forward
POST
Document Template with Body, Header, Footer/{wabaid}/message_templatesThis API is used for creating document templates with body, header and footer.
arrow_forward
POST
Document Template with Body, Header, Footer, Visit Website and Call to Phone/{wabaid}/message_templatesThis API is used for creating document templates with body, header, footer,visit website and call to phone.
arrow_forward
POST
Document Template with Body, Header, Footer, Quick Reply/{wabaid}/message_templatesThis API is used for creating document templates with body, header, footer and quick reply.
arrow_forward
POST
Video Template with Body, Header, Footer/{wabaid}/message_templatesThis API is used for creating video templates with body, header and footer.
arrow_forward
POST
Video Template with Body, Header, Footer, Quick Reply/{wabaid}/message_templatesThis API is used for creating video templates with body, header, footer and quick reply.
arrow_forward
POST
Video Template with Body, Header, Footer, Visit Website and Call to Phone/{wabaid}/message_templatesThis API is used for creating video templates with body, header, footer, visit website and call to phone.
arrow_forward
POST
Image Template with Multiple Button/{wabaid}/message_templatesThis API is used for creating image templates with multiple buttons.
arrow_forward
POST
Image Template with Multiple Button and Dynamic URL Placeholder/{wabaid}/message_templatesThis API is used for creating image templates with multiple buttons and a dynamic url placeholder.
arrow_forward
POST
Video Template with Multiple Button/{wabaid}/message_templatesThis API is used for creating video templates with multiple buttons.
arrow_forward
POST
Video Template with Multiple Button and Dynamic URL Placeholder/{wabaid}/message_templatesThis API is used for creating video templates with multiple buttons and a dynamic url placeholder.
arrow_forward
POST
Document Template with Multiple Button/{wabaid}/message_templatesThis API is used for creating document templates with multiple buttons.
arrow_forward
POST
Document Template with Multiple Button and Dynamic URL Placeholder/{wabaid}/message_templatesThis API is used for creating document templates with multiple buttons and a dynamic url placeholder.
arrow_forward
POST
Location Template with Multiple Button/{wabaid}/message_templatesThis API is used for creating location templates with multiple buttons.
arrow_forward
POST
Location Template with Multiple Button and Dynamic URL Placeholder/{wabaid}/message_templatesThis API is used for creating location templates with multiple buttons and a dynamic url placeholder.
arrow_forward
POST
Text Template with Multiple Button/{wabaid}/message_templatesThis API is used for creating text templates with multiple buttons.
arrow_forward
POST
Text Template with Multiple Button and Dynamic URL Placeholder/{wabaid}/message_templatesThis API is used for creating text templates with multiple buttons and a dynamic url placeholder.
arrow_forward
POST
Coupon Template/{wabaid}/message_templatesThis API is used for coupon code templates.
arrow_forward
POST
MPM Template/{wabaid}/message_templatesThis API is used for creating multi product message(MPM) templates.
arrow_forward
POST
Image Carousel Template without Body Placeholder/{wabaid}/message_templatesThis API is used for creating image carousel templates without body placeholder.
arrow_forward
POST
Image Carousel Template with Body Placeholder/{wabaid}/message_templatesThis API is used for creating image carousel templates with body placeholders.
arrow_forward
POST
Video Carousel Template without Body Placeholder/{wabaid}/message_templatesThis API is used for creating video carousel templates without body placeholders.
arrow_forward
POST
Video Carousel Template with Body Placeholder/{wabaid}/message_templatesThis API is used for creating video carousel templates with body placeholders.
arrow_forward
GET
Get template with pagination/{wabaid}/message_templatesThis API is used to check how many templates are there for particular user.
arrow_forward
GET
Get all templates/{wabaid}/message_templatesThis API is used to check all the templates for a particular user.
arrow_forward
GET
Get all template namespaces/{wabaid}This API is used to check all template namespaces for a particular user.
arrow_forward
GET
Get template with id/{msgtemplateid}This API is used to check the template using template id.
arrow_forward
POST
Edit Template/{msgtemplateid}This API is used to edit the template. If your template status has been set to REJECTED as part of category validation, you have several options: 1. Edit the template's components. 2. Edit the template's category. 3. Create a new template.
arrow_forward
DELETE
Delete Template by name/{wabaid}/message_templatesThis API is used to delete the template by its name
arrow_forward
DELETE
Delete Template by name and id/{wabaid}/message_templatesThis API is used to delete the template by its name and id
arrow_forward
POST
Create Authentication One Tap Template/{wabaid}/message_templatesThis API is used to create one tap authentication template.
arrow_forward
POST
Create Authentication Zero Tap Template/{wabaid}/message_templatesThis API is used to create a zero tap authentication template.
arrow_forward
POST
Create Authentication Copy Code Template/{wabaid}/message_templatesThis API is used to create a copy code authentication template.
arrow_forward
POST
Send Authentication Template Message/{phone_number_id}/messagesThis API is used to send an authentication template message.
arrow_forward
Media
POST
UPLOAD MEDIA
/{phone_number_id}/mediaThis API is used to upload the media on your
arrow_forward
POST
DOWNLOAD MEDIA DIRECTLY/downloadMedia/{mediaid}This API is used to download the media by passing the mediaid as parameter in the URL.
arrow_forward
GET
GET MEDIA URL FROM MEDIA ID/{mediaid}This API is used to get the media url by passing the mediaid as parameter in the URL.
arrow_forward
GET
GET MEDIA FROM MEDIA URL/whatsapp_business/attachments/This API is used to get the media by calling the media url.
arrow_forward
DELETE
DELETE MEDIA/{mediaid}This API is used to delete the media by passing the mediaid as parameter in the URL.
arrow_forward
POST
Retrieve media file handle - Step 1 : Create a Session/app/uploadsThis API is used to get the upload session ID that will be used in the next step to initiate the upload.
arrow_forward
POST
Retrieve media file handle - Step 2 : Create a Session/upload:MTphdHRhY2htZW50OjNlYTE1ZTkzLTZkZDktNGIwOS1iOTM3LWM4YWZmMTRkYTZkMz9maWxlX2xlbmd0aD0xNjQzMTMmZmlsZV90eXBlPXZpZGVvJTJGbXA0This API is used to initiate the upload session by sending a POST request and append your upload session {id} along with the required headers indicated below. Upon success, a file handle, {h}, is returned that you can then use with any Partners API endpoints that support file handles returned by the Resumable Upload API.
arrow_forward
Business Accounts
GET
Get user details
/getuserdetailsThis API is used to fetch user details
arrow_forward
GET
Fetch Waba Information/{wabaid}This API is used to fetch the waba details.
arrow_forward
GET
Get Owned Whatsapp Business Accounts/{business-id}/owned_whatsapp_business_accountsThis API is used to fetch the owned whatsapp business accounts details for the given business id.
arrow_forward
GET
Get Client Whatsapp Business Accounts/{business-id}/client_whatsapp_business_accountsThis API is used to fetch the client whatsapp business accounts details for the given business id.
arrow_forward
GET
Get Whatsapp Business Profile/{phone_number_id}/whatsapp_business_profileThis API is used to fetch the whatsapp business profile details for the given phone number id.
arrow_forward
Webhooks & Security
POST
Set Webhook
/{phone_number_id}/setwebhookThis API is used to set a webhook url against the waba using phone number id. The callback payload received from Meta will be relayed to this webhook url along with the custom values as specified in the headers parameter of the request body.
arrow_forward
GET
Get Webhook/{phone_number_id}/getwebhookThis API is used to get the webhook url against the waba using phone number id.
arrow_forward
POST
Set Whatsapp Business Encryption Key/flows/{phone_number_id}/set_whatsapp_business_encryptionThis API is used to set the whatsapp business encryption key using phone number id.
arrow_forward
GET
Get Whatsapp Business Encryption Key/flows/{phone_number_id}/get_private_keyThis API is used to get the whatsapp business encryption key using phone number id.
arrow_forward
QR Codes
GET
Get QR code
/business/{businessPhoneNumberId}/message_qrdlsThis API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
arrow_forward
GET
Get all QR codes (default fields)/business/{businessPhoneNumberId}/message_qrdlsThis API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
arrow_forward
GET
Get all QR codes (specific fields)/business/{businessPhoneNumberId}/message_qrdlsThis API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
arrow_forward
GET
Get QR code SVG image URL/business/{businessPhoneNumberId}/message_qrdlsThis API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
arrow_forward
GET
Get QR code PNG image URL/business/{businessPhoneNumberId}/message_qrdlsThis API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
arrow_forward
POST
Create QR code/business/{businessPhoneNumberId}/message_qrdlsThis API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
arrow_forward
POST
Update Message QR Code/business/{businessPhoneNumberId}/message_qrdlsThis API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
arrow_forward
DELETE
Delete QR code/business/{businessPhoneNumberId}/message_qrdls/:codeIdThis API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
arrow_forward
search_off
No Matching Endpoints
Try a different keyword or HTTP method.
