This collection provides endpoints for sending WhatsApp messages immediately or scheduling them for delivery at a future time.
\nKey Features:
\nImmediate or Scheduled Delivery: Send messages right away or specify a date/time for future delivery.
\nTemplate-based Messaging: Messages must use pre-approved WhatsApp templates, supporting placeholders for personalization.
\nMedia Attachments: Depending on the template type, you can attach images, videos, documents, or PDFs.
\nSingle or Bulk Messaging: Send to a single recipient or to multiple recipients in one request.
\nTimezone Awareness: Scheduling respects the client’s timezone (default: West Africa Standard Time).
\nUse these APIs to reliably reach your users with transactional updates, alerts, or marketing campaigns over WhatsApp.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5965625","collectionId":"c507f4af-e889-46f2-aa98-f71ff3d8bbd3","publishedId":"2sB3HooeR5","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-09-13T11:40:53.000Z"},"item":[{"name":"GetToken","id":"9604437d-a472-4d89-b2b1-46adbcdb2800","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientId\": \"MIoi5hR\",\n \"clientSecret\": \"9ga9+Jw3DEev+nU4oNLKjQ==\"\n}","options":{"raw":{"language":"json"}}},"url":"/api/business-auth/token","description":"This is to generate token needed to send whatsapp api. Time zone is optional for countries outside west africa. It is required to state for others for proper scheduling.
\nThe Client Id is the Id on your dashboard when you login into the app
\nThe ClientSecret is the secret that is sent to your email. Only you know what this value is.
\n","urlObject":{"path":["api","business-auth","token"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"351ea9ff-b1f2-4f40-a2c3-68c2cb2372d3","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientId\": \"MIoi5hR\",\n \"clientSecret\": \"1PBTKns7Fkam3GS8X93Mbg==\" \n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:5004/api/business-auth/token"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Wed, 10 Sep 2025 09:16:30 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWQiOiJNSW9pNWhSIiwicm9sZSI6IkJ1c2luZXNzIiwibmJmIjoxNzU3NDk1NzkxLCJleHAiOjE3NjI2Nzk3OTEsImlhdCI6MTc1NzQ5NTc5MSwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo1MDAyLyIsImF1ZCI6IlFSVGVtcGxhdGUifQ.Vq1Rlajoz9-o9mvFBJUf0vFEsgMub6ydNrEu73Pertg\"\n}"},{"id":"723304b8-44d0-405f-904d-573b7dd4c5a3","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientId\": \"MIoi5h\",\n \"clientSecret\": \"1PBTKns7Fkam3GS8X93Mbg==\" \n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:5004/api/business-auth/token"},"status":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Date","value":"Wed, 10 Sep 2025 09:19:20 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"Invalid client credentials."},{"id":"e3471369-be29-428f-bfa8-1cc788df7519","name":"GetToken-TimeZone","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientId\": \"MIoi5hR\",\n \"clientSecret\": \"JlYDnxOOSEy1Yl1kn5Znxg==\",\n \"timezone\": \"W. Central Africa Standard Time\"\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:5004/api/business-auth/token"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 11 Sep 2025 19:03:32 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWQiOiJNSW9pNWhSIiwidGltZXpvbmUiOiJXLiBDZW50cmFsIEFmcmljYSBTdGFuZGFyZCBUaW1lIiwibmJmIjoxNzU3NjE3NDEyLCJleHAiOjE3NjI4MDE0MTIsImlhdCI6MTc1NzYxNzQxMiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo1MDAyLyIsImF1ZCI6IlFSVGVtcGxhdGUifQ.rbKI2MzAiNKs01B5Nc5hIB1PO4qosWaMYIRzahSYDZo\"\n}"},{"id":"a1660257-d886-403c-a397-631254003457","name":"GetToken-NoTimeZone","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientId\": \"MIoi5hR\",\n \"clientSecret\": \"JlYDnxOOSEy1Yl1kn5Znxg==\"\n}","options":{"raw":{"language":"json"}}},"url":"https://localhost:5004/api/business-auth/token"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 11 Sep 2025 19:04:02 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRfaWQiOiJNSW9pNWhSIiwidGltZXpvbmUiOiJXLiBDZW50cmFsIEFmcmljYSBTdGFuZGFyZCBUaW1lIiwibmJmIjoxNzU3NjE3NDQyLCJleHAiOjE3NjI4MDE0NDIsImlhdCI6MTc1NzYxNzQ0MiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo1MDAyLyIsImF1ZCI6IlFSVGVtcGxhdGUifQ.LppTWa51cHlhAOqvH6dRAVauJQmmB8SoSTefgTqP8e8\"\n}"}],"_postman_id":"9604437d-a472-4d89-b2b1-46adbcdb2800"},{"name":"Regenerate Secret","id":"6aac1e21-e5ca-44aa-ac3e-844601965615","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"This is the secret that will be sent to your email when you pass your clientId. Remember the ClientId is located on the app dashboard under the brand name AccessCheck
This shows all the template available in whatsapp. You can use any one,if peradventure the one that suit you is not there you can contact admin to submit your favorable one.
\nThe category of of your template is used to determine what facebook remove from your wallet.
\nPurpose: Promote products, services, offers, or events to users.
\nExample:
\nSending a special discount coupon:
\"Get 20% off your next purchase! Use code SAVE20 at checkout.\"
Announcing a new product launch:
\"Introducing our new organic snack line – available now!\"
Purpose: Share useful information or updates related to a user’s account, service, or transaction.
\nExample:
\nSending booking confirmations:
\"Your flight to Lagos has been confirmed. Booking ID: 12345.\"
Sending appointment reminders:
\"Reminder: Your dentist appointment is scheduled for tomorrow at 10:00 AM.\"
Purpose: Verify user identity or secure transactions via OTP, password reset, or two-factor authentication.
\nExample:
\nSending an OTP for login:
\"Your verification code is 456789.\"
Password reset link:
\"Click here to reset your password: https://example.com/reset?token=abc123\"
Description:
\nFetch a WhatsApp message template by its name. Returns the template details, including its components (BODY, HEADER, FOOTER), language, category, and status.EndFragment
StartFragment
Query Parameters:
\nsuccess Response
\n{
\"name\": \"hello_world\",
\"language\": \"en_US\",
\"status\": \"approved\",
\"category\": \"MARKETING\",
\"components\": [
{
\"type\": \"BODY\",
\"text\": \"Hello {{1}}, welcome to our service!\",
\"format\": null
},
{
\"type\": \"HEADER\",
\"text\": null,
\"format\": \"TEXT\"
},
{
\"type\": \"FOOTER\",
\"text\": \"Thank you for choosing us.\",
\"format\": null
}
]
}
StartFragment
\nCategory Descriptions:
\nMARKETING: Promotional messages to users (offers, product launches).
\nUTILITY: Informational or service messages (appointment reminders, confirmations).
\nAUTHENTICATION: Security messages (OTP, password reset).
\nThis requires a payment to be made via the platform before you proceed reason being that for every successfull call you made Meta charges the system based on the category.
\nSample Payload
\nThe Template is the name of the whatsapp template that you want to use. It is predefined by the admin based on your need or ask
\nEventId : This is the event that you created via the application
\nFileUrl : This is required if the header of your component in the whatsapp template requires a file.Video,Image,Document,PDF. Ensure to place valid link if not it will not go through and time would have been wasted
\nPlaceHolders: This is the one that holds your receiver information.
\nThe Phone number is the person you are sending the imformation to, please include country code
\nThe sendAt is what determines when the message should be sent, if it immediate you can remove it or pass null else pass a validate in this format yyyy-MM-dd HH:mm:ss (2025-10-11 23:00:00)
\nThe parameters: The template you choose might have changing dynamic values per users this is where you will pass them. It is a key value variable (Dictionary)
\n