# WhatsApp 3.0

Lifecycle: **active**

WhatsApp Partners API v3 reference with 95 documented operations.

Base URL: `https://partnersv1.pinbot.ai/v3`

- [OpenAPI JSON](https://devdocs.pinnacle.in/docs/whatsapp/3-0/openapi.json)
- [OpenAPI YAML](https://devdocs.pinnacle.in/docs/whatsapp/3-0/openapi.yaml)

## Published endpoints

- [POST /{phone_number_id}/messages — Send Text Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-text-message.md) — This API is used to send the text message to the end user using the Whatsapp CDC panel.
- [POST /{phone_number_id}/messages — Send Location Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-location-message.md) — This API is used to send the location message to the end user.
- [POST /{phone_number_id}/messages — Send Image Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-image-message.md) — This API is used to send the image message to the end user.
- [POST /{phone_number_id}/messages — Send Document Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-document-message.md) — This API is used to send the document message to the end user.
- [POST /{phone_number_id}/messages — Send Video Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-video-message.md) — This API is used to send the video message to the end user.
- [POST /{phone_number_id}/messages — Send Contact Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-contact-message.md) — This API is used to send the contact message to the end user.
- [POST /{phone_number_id}/messages — Send Interactive Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-interactive-message.md) — This API is used to send the interactive message to the end user.
- [POST /{phone_number_id}/messages — Order details](https://devdocs.pinnacle.in/docs/whatsapp/3-0/order-details.md) — Order details from the Partners API documentation.
- [POST /{phone_number_id}/messages — Order Status](https://devdocs.pinnacle.in/docs/whatsapp/3-0/order-status.md) — Order Status from the Partners API documentation.
- [POST /{phone_number_id}/messages — Single Product Catalogue](https://devdocs.pinnacle.in/docs/whatsapp/3-0/single-product-catalogue.md) — This API is used to send the catalogue message for a single product.
- [POST /{phone_number_id}/messages — MultiProduct Catalogue](https://devdocs.pinnacle.in/docs/whatsapp/3-0/multiproduct-catalogue.md) — This API is used to send the catalogue message for a multiple product.
- [POST /{phone_number_id}/messages — Send Text Template Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-text-template-message.md) — This API is used to send the text template message to the end user.
- [POST /{phone_number_id}/messages — Send Media Template Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-media-template-message.md) — This API is used to send the media template message to the end user.
- [POST /{phone_number_id}/messages — Send Interactive Template Message - Call to Action](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-interactive-template-message-call-to-action.md) — This API is used to send the interactive template message(Call to Action) to the end user.
- [POST /{phone_number_id}/messages — Send Interactive Media Template Message - Quick Reply](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-interactive-media-template-message-quick-reply.md) — This API is used to send the interactive media template message(Quick Reply) to the end user.
- [POST /{phone_number_id}/messages — Send Media Template Message with multiple button](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-media-template-message-with-multiple-button.md) — This API is used to send the image template with multiple button messages to the end user.
- [POST /{phone_number_id}/messages — Send Media Template Message with multiple button](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-media-template-message-with-multiple-button-page-48.md) — This API is used to send the image template message with multiple buttons and dynamic url placeholder to the end user.
- [POST /{phone_number_id}/messages — Send Coupon Code Template Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-coupon-code-template-message.md) — This API is used to send the coupon code template message to the end user.
- [POST /{phone_number_id}/messages — Send MPM Template Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-mpm-template-message.md) — This API is used to send the multiple product template message to the end user.
- [POST /{phone_number_id}/messages — Send Limited Time Offer Template Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-limited-time-offer-template-message.md) — This API is used to send the limited time offer template message to the end user.
- [POST /{phone_number_id}/messages — Send Carousel Template Message without Body placeholder](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-carousel-template-message-without-body-placeholder.md) — This API is used to send the carousel template message without the body placeholders to the end user.
- [POST /{phone_number_id}/messages — Send Carousel Template Message with Body placeholder](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-carousel-template-message-with-body-placeholder.md) — This API is used to send the carousel template message with body placeholders to the end user.
- [POST /{phone_number_id}/messages — Send Location Request Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-location-request-message.md) — This API is used to send the location request message to the end user.
- [POST /{phone_number_id}/messages — Send Address Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-address-message.md) — This API is used to send the address message to the end user.
- [POST /{phone_number_id}/media — UPLOAD MEDIA](https://devdocs.pinnacle.in/docs/whatsapp/3-0/upload-media.md) — This API is used to upload the media on your
- [POST /downloadMedia/{mediaid} — DOWNLOAD MEDIA DIRECTLY](https://devdocs.pinnacle.in/docs/whatsapp/3-0/download-media-directly.md) — This API is used to download the media by passing the mediaid as parameter in the URL.
- [GET /{mediaid} — GET MEDIA URL FROM MEDIA ID](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-media-url-from-media-id.md) — This API is used to get the media url by passing the mediaid as parameter in the URL.
- [GET /whatsapp_business/attachments/ — GET MEDIA FROM MEDIA URL](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-media-from-media-url.md) — This API is used to get the media by calling the media url.
- [DELETE /{mediaid} — DELETE MEDIA](https://devdocs.pinnacle.in/docs/whatsapp/3-0/delete-media.md) — This API is used to delete the media by passing the mediaid as parameter in the URL.
- [POST /app/uploads — Retrieve media file handle - Step 1 : Create a Session](https://devdocs.pinnacle.in/docs/whatsapp/3-0/retrieve-media-file-handle-step-1-create-a-session.md) — This API is used to get the upload session ID that will be used in the next step to initiate the upload.
- [POST /upload:MTphdHRhY2htZW50OjNlYTE1ZTkzLTZkZDktNGIwOS1iOTM3LWM4YWZmMTRkYTZkMz9maWxlX2xlbmd0aD0xNjQzMTMmZmlsZV90eXBlPXZpZGVvJTJGbXA0 — Retrieve media file handle - Step 2 : Create a Session](https://devdocs.pinnacle.in/docs/whatsapp/3-0/retrieve-media-file-handle-step-2-create-a-session.md) — This 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.
- [POST /{wabaid}/message_templates — Text Template with Body, header, quick reply](https://devdocs.pinnacle.in/docs/whatsapp/3-0/text-template-with-body-header-quick-reply.md) — This API is used for creating text templates with body, header and quick reply.
- [POST /{wabaid}/message_templates — Text Template with Body, header, footer](https://devdocs.pinnacle.in/docs/whatsapp/3-0/text-template-with-body-header-footer.md) — This API is used for creating text templates with body, header and footer.
- [POST /{wabaid}/message_templates — Text Template with Body, Header, Footer, Visit Website and Call to Phone](https://devdocs.pinnacle.in/docs/whatsapp/3-0/text-template-with-body-header-footer-visit-website-and-call-to-phone.md) — This API is used for creating text templates with body, header,footer, Visit website and call to phone.
- [POST /{wabaid}/message_templates — Image Template with Body, Header, Footer](https://devdocs.pinnacle.in/docs/whatsapp/3-0/image-template-with-body-header-footer.md) — This API is used for creating image templates with body, header and footer.
- [POST /{wabaid}/message_templates — Image Template with Body, Header, Footer, Visit Website and Call to Phone](https://devdocs.pinnacle.in/docs/whatsapp/3-0/image-template-with-body-header-footer-visit-website-and-call-to-phone.md) — This API is used for creating image templates with body, header, footer, visit website and call to phone.
- [POST /{wabaid}/message_templates — Image Template with Body, Header, Footer, Quick Reply](https://devdocs.pinnacle.in/docs/whatsapp/3-0/image-template-with-body-header-footer-quick-reply.md) — This API is used for creating image templates with body, header, footer, and quick reply
- [POST /{wabaid}/message_templates — Document Template with Body, Header, Footer](https://devdocs.pinnacle.in/docs/whatsapp/3-0/document-template-with-body-header-footer.md) — This API is used for creating document templates with body, header and footer.
- [POST /{wabaid}/message_templates — Document Template with Body, Header, Footer, Visit Website and Call to Phone](https://devdocs.pinnacle.in/docs/whatsapp/3-0/document-template-with-body-header-footer-visit-website-and-call-to-phone.md) — This API is used for creating document templates with body, header, footer,visit website and call to phone.
- [POST /{wabaid}/message_templates — Document Template with Body, Header, Footer, Quick Reply](https://devdocs.pinnacle.in/docs/whatsapp/3-0/document-template-with-body-header-footer-quick-reply.md) — This API is used for creating document templates with body, header, footer and quick reply.
- [POST /{wabaid}/message_templates — Video Template with Body, Header, Footer](https://devdocs.pinnacle.in/docs/whatsapp/3-0/video-template-with-body-header-footer.md) — This API is used for creating video templates with body, header and footer.
- [POST /{wabaid}/message_templates — Video Template with Body, Header, Footer, Quick Reply](https://devdocs.pinnacle.in/docs/whatsapp/3-0/video-template-with-body-header-footer-quick-reply.md) — This API is used for creating video templates with body, header, footer and quick reply.
- [POST /{wabaid}/message_templates — Video Template with Body, Header, Footer, Visit Website and Call to Phone](https://devdocs.pinnacle.in/docs/whatsapp/3-0/video-template-with-body-header-footer-visit-website-and-call-to-phone.md) — This API is used for creating video templates with body, header, footer, visit website and call to phone.
- [POST /{wabaid}/message_templates — Image Template with Multiple Button](https://devdocs.pinnacle.in/docs/whatsapp/3-0/image-template-with-multiple-button.md) — This API is used for creating image templates with multiple buttons.
- [POST /{wabaid}/message_templates — Image Template with Multiple Button and Dynamic URL Placeholder](https://devdocs.pinnacle.in/docs/whatsapp/3-0/image-template-with-multiple-button-and-dynamic-url-placeholder.md) — This API is used for creating image templates with multiple buttons and a dynamic url placeholder.
- [POST /{wabaid}/message_templates — Video Template with Multiple Button](https://devdocs.pinnacle.in/docs/whatsapp/3-0/video-template-with-multiple-button.md) — This API is used for creating video templates with multiple buttons.
- [POST /{wabaid}/message_templates — Video Template with Multiple Button and Dynamic URL Placeholder](https://devdocs.pinnacle.in/docs/whatsapp/3-0/video-template-with-multiple-button-and-dynamic-url-placeholder.md) — This API is used for creating video templates with multiple buttons and a dynamic url placeholder.
- [POST /{wabaid}/message_templates — Document Template with Multiple Button](https://devdocs.pinnacle.in/docs/whatsapp/3-0/document-template-with-multiple-button.md) — This API is used for creating document templates with multiple buttons.
- [POST /{wabaid}/message_templates — Document Template with Multiple Button and Dynamic URL Placeholder](https://devdocs.pinnacle.in/docs/whatsapp/3-0/document-template-with-multiple-button-and-dynamic-url-placeholder.md) — This API is used for creating document templates with multiple buttons and a dynamic url placeholder.
- [POST /{wabaid}/message_templates — Location Template with Multiple Button](https://devdocs.pinnacle.in/docs/whatsapp/3-0/location-template-with-multiple-button.md) — This API is used for creating location templates with multiple buttons.
- [POST /{wabaid}/message_templates — Location Template with Multiple Button and Dynamic URL Placeholder](https://devdocs.pinnacle.in/docs/whatsapp/3-0/location-template-with-multiple-button-and-dynamic-url-placeholder.md) — This API is used for creating location templates with multiple buttons and a dynamic url placeholder.
- [POST /{wabaid}/message_templates — Text Template with Multiple Button](https://devdocs.pinnacle.in/docs/whatsapp/3-0/text-template-with-multiple-button.md) — This API is used for creating text templates with multiple buttons.
- [POST /{wabaid}/message_templates — Text Template with Multiple Button and Dynamic URL Placeholder](https://devdocs.pinnacle.in/docs/whatsapp/3-0/text-template-with-multiple-button-and-dynamic-url-placeholder.md) — This API is used for creating text templates with multiple buttons and a dynamic url placeholder.
- [POST /{wabaid}/message_templates — Coupon Template](https://devdocs.pinnacle.in/docs/whatsapp/3-0/coupon-template.md) — This API is used for coupon code templates.
- [POST /{wabaid}/message_templates — MPM Template](https://devdocs.pinnacle.in/docs/whatsapp/3-0/mpm-template.md) — This API is used for creating multi product message(MPM) templates.
- [POST /{wabaid}/message_templates — Image Carousel Template without Body Placeholder](https://devdocs.pinnacle.in/docs/whatsapp/3-0/image-carousel-template-without-body-placeholder.md) — This API is used for creating image carousel templates without body placeholder.
- [POST /{wabaid}/message_templates — Image Carousel Template with Body Placeholder](https://devdocs.pinnacle.in/docs/whatsapp/3-0/image-carousel-template-with-body-placeholder.md) — This API is used for creating image carousel templates with body placeholders.
- [POST /{wabaid}/message_templates — Video Carousel Template without Body Placeholder](https://devdocs.pinnacle.in/docs/whatsapp/3-0/video-carousel-template-without-body-placeholder.md) — This API is used for creating video carousel templates without body placeholders.
- [POST /{wabaid}/message_templates — Video Carousel Template with Body Placeholder](https://devdocs.pinnacle.in/docs/whatsapp/3-0/video-carousel-template-with-body-placeholder.md) — This API is used for creating video carousel templates with body placeholders.
- [GET /{wabaid}/message_templates — Get template with pagination](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-template-with-pagination.md) — This API is used to check how many templates are there for particular user.
- [GET /{wabaid}/message_templates — Get all templates](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-all-templates.md) — This API is used to check all the templates for a particular user.
- [GET /{wabaid} — Get all template namespaces](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-all-template-namespaces.md) — This API is used to check all template namespaces for a particular user.
- [GET /{msgtemplateid} — Get template with id](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-template-with-id.md) — This API is used to check the template using template id.
- [POST /{msgtemplateid} — Edit Template](https://devdocs.pinnacle.in/docs/whatsapp/3-0/edit-template.md) — 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.
- [DELETE /{wabaid}/message_templates — Delete Template by name](https://devdocs.pinnacle.in/docs/whatsapp/3-0/delete-template-by-name.md) — This API is used to delete the template by its name
- [DELETE /{wabaid}/message_templates — Delete Template by name and id](https://devdocs.pinnacle.in/docs/whatsapp/3-0/delete-template-by-name-and-id.md) — This API is used to delete the template by its name and id
- [GET /getuserdetails — Get user details](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-user-details.md) — This API is used to fetch user details
- [POST /{phone_number_id}/messages — Mark message as read](https://devdocs.pinnacle.in/docs/whatsapp/3-0/mark-message-as-read.md) — This API is used to set the status of the message id as read
- [POST /{phone_number_id}/messages — Payment refund](https://devdocs.pinnacle.in/docs/whatsapp/3-0/payment-refund.md) — This API is used by the business to initiate a refund for an order.
- [GET /{wabaid} — Fetch Waba Information](https://devdocs.pinnacle.in/docs/whatsapp/3-0/fetch-waba-information.md) — This API is used to fetch the waba details.
- [POST /{phone_number_id}/setwebhook — Set Webhook](https://devdocs.pinnacle.in/docs/whatsapp/3-0/set-webhook.md) — This 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.
- [GET /{phone_number_id}/getwebhook — Get Webhook](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-webhook.md) — This API is used to get the webhook url against the waba using phone number id.
- [POST /flows/{phone_number_id}/set_whatsapp_business_encryption — Set Whatsapp Business Encryption Key](https://devdocs.pinnacle.in/docs/whatsapp/3-0/set-whatsapp-business-encryption-key.md) — This API is used to set the whatsapp business encryption key using phone number id.
- [GET /flows/{phone_number_id}/get_private_key — Get Whatsapp Business Encryption Key](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-whatsapp-business-encryption-key.md) — This API is used to get the whatsapp business encryption key using phone number id.
- [GET /{phone_number_id}/payments/{payment_configuration}/{order-id} — Get Payment Status](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-payment-status.md) — This API is used to get the payment status for the given order id using phone number id.
- [POST /{catalog-id}/batch — Create Catalog Product](https://devdocs.pinnacle.in/docs/whatsapp/3-0/create-catalog-product.md) — This API is used to add a product in the given catalog id.
- [POST /{catalog-id}/batch — Update Catalog Product](https://devdocs.pinnacle.in/docs/whatsapp/3-0/update-catalog-product.md) — This API is used to update a product in the given catalog id.
- [POST /{catalog-id}/batch — Delete Catalog Product](https://devdocs.pinnacle.in/docs/whatsapp/3-0/delete-catalog-product.md) — This API is used to delete a product in the given catalog id.
- [GET /{catalog-id}/products — Product Catalog API](https://devdocs.pinnacle.in/docs/whatsapp/3-0/product-catalog-api.md) — This API is used to fetch the products in the given catalog id.
- [GET /fetchcatalogId — Product Catalog API](https://devdocs.pinnacle.in/docs/whatsapp/3-0/product-catalog-api-page-224.md) — This API is used to fetch the catalog id for the given waba number.
- [GET /{business-id}/owned_whatsapp_business_accounts — Get Owned Whatsapp Business Accounts](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-owned-whatsapp-business-accounts.md) — This API is used to fetch the owned whatsapp business accounts details for the given business id.
- [GET /{business-id}/client_whatsapp_business_accounts — Get Client Whatsapp Business Accounts](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-client-whatsapp-business-accounts.md) — This API is used to fetch the client whatsapp business accounts details for the given business id.
- [GET /{phone_number_id}/whatsapp_business_profile — Get Whatsapp Business Profile](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-whatsapp-business-profile.md) — This API is used to fetch the whatsapp business profile details for the given phone number id.
- [POST /{wabaid}/message_templates — Create Authentication One Tap Template](https://devdocs.pinnacle.in/docs/whatsapp/3-0/create-authentication-one-tap-template.md) — This API is used to create one tap authentication template.
- [POST /{wabaid}/message_templates — Create Authentication Zero Tap Template](https://devdocs.pinnacle.in/docs/whatsapp/3-0/create-authentication-zero-tap-template.md) — This API is used to create a zero tap authentication template.
- [POST /{wabaid}/message_templates — Create Authentication Copy Code Template](https://devdocs.pinnacle.in/docs/whatsapp/3-0/create-authentication-copy-code-template.md) — This API is used to create a copy code authentication template.
- [POST /{phone_number_id}/messages — Send Authentication Template Message](https://devdocs.pinnacle.in/docs/whatsapp/3-0/send-authentication-template-message.md) — This API is used to send an authentication template message.
- [GET /business/{businessPhoneNumberId}/message_qrdls — Get QR code](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-qr-code.md) — This API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
- [GET /business/{businessPhoneNumberId}/message_qrdls — Get all QR codes (default fields)](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-all-qr-codes-default-fields.md) — This API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
- [GET /business/{businessPhoneNumberId}/message_qrdls — Get all QR codes (specific fields)](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-all-qr-codes-specific-fields.md) — This API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
- [GET /business/{businessPhoneNumberId}/message_qrdls — Get QR code SVG image URL](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-qr-code-svg-image-url.md) — This API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
- [GET /business/{businessPhoneNumberId}/message_qrdls — Get QR code PNG image URL](https://devdocs.pinnacle.in/docs/whatsapp/3-0/get-qr-code-png-image-url.md) — This API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
- [POST /business/{businessPhoneNumberId}/message_qrdls — Create QR code](https://devdocs.pinnacle.in/docs/whatsapp/3-0/create-qr-code.md) — This API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
- [POST /business/{businessPhoneNumberId}/message_qrdls — Update Message QR Code](https://devdocs.pinnacle.in/docs/whatsapp/3-0/update-message-qr-code.md) — This API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.
- [DELETE /business/{businessPhoneNumberId}/message_qrdls/:codeId — Delete QR code](https://devdocs.pinnacle.in/docs/whatsapp/3-0/delete-qr-code.md) — This API is used to confirm that template analytics capture will begin for the WhatsApp Business Account.