Set ice breakers, commands or the welcome message
https://api.app2email.com/v1/{number}/settings/conversation-starters Replaces the parts given. A tap or a command arrives as a normal text message (forwarded by email as usual).
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Body application/json required
-
Ice breakers. No emoji. [] removes them.
-
Slash commands. No emoji. [] removes them. Meta's command_name / command_description work too.
2 item fields
- welcome_message boolean
Meta's enable_welcome_message: a request_welcome message when a user opens a chat for the first time.
Responses
Fields
- e.g.
true - e.g.
k3x9a - conversation_starters objectFields: as the request body
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 422 The request is understood but cannot be sent (template parameters, media, text, recipient, or a WhatsApp rule such as the 24 hour window).
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.
- 502 WhatsApp (Meta) returned an error or could not be reached.
- 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.