API Reference

Start chatbot (Available in Pro plan)

post
https://live-mt-server.wati.io/api/ext/v3/chatbots/start

Start chatbot (Available in Pro plan). POST /api/ext/v3/chatbots/start.

Permissions

For API access tokens and OIDC tokens, satisfy at least one of: api, chatbotsv3:write. API access tokens may satisfy a listed scope through the configured scope hierarchy; OIDC tokens are checked against their scope claims. Legacy JWT authentication does not use this scope check. Authentication, role, tenant, and applicable feature or plan checks still apply. For HTTP 403, check the credential type, applicable scopes, roles, and workspace access; 403 does not always mean a missing scope. Authentication/authorization failures do not guarantee a JSON response body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request model for starting a chatbot.

string
required

The target recipient in the following formats:

  • ContactId: The unique ID of a contact.
  • PhoneNumber: The recipient's phone number (e.g., 14155552671).
  • Channel:ContactId: A combination of the channel (name or phone number) and the recipient's phone number (e.g., MyChannel:65b73810e2bd04aa867b5f7d, 123456789:65b73810e2bd04aa867b5f7d).
  • Channel:PhoneNumber: A combination of the channel (name or phone number) and the recipient's phone number (e.g., MyChannel:1415552671, 123456789:1415552671).
string
required

Chatbot ID.

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

401

The request is unauthorized.

429

Too many requests. Either the rate limit has been exceeded or usage limits have been reached.

Updated 3 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago