Change some of the number's settings
https://api.app2email.com/v1/{number}/settings/number Needs the 'settings:manage' scope. Only the keys given change; nested objects ({"email": {"mark_read_on_open": true}}) or dotted keys ({"email.mark_read_on_open": true}) both work. Not with a sandbox key.
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
- email object
4 fields
-
An email to the sender when their email reply failed on WhatsApp (or for every status).
failed_onlynoneall -
Send WhatsApp a read receipt when the forwarded email is opened.
-
Earlier messages of the conversation quoted under a forwarded message (the [HISTORY] block), at most 100. 0 = none and no Show All History button. 20 is what every number had before this setting existed. The dashboard offers 0, 10, 20, 50 and 100 (Chat History Summary).
-
What goes under a photo the contact sent in that history. The photo's own line ([IMAGE, file name, type, size]) is always shown. name: nothing more. link: a line with the link to the full-size photo. thumbnail: a small picture linked to the full-size photo; it is loaded from that link, not attached to the email. A photo app2email has no copy of gets nothing more. The dashboard calls it Images in Chat History Summary.
namelinkthumbnail
-
- caps object
1 fields
-
Your own monthly cap on outgoing messages (WhatsApp + email). 0 = the plan limit only.
-
- compliance object
2 fields
-
Appended once to automated replies (auto reply, agents), eg 'This reply was generated automatically.'
- stop_keywords_extra string[]
Your own opt-out words besides the built-in ones (STOP and its translations).
-
- a2a object
1 fields
-
Skip the A2A / OpenClaw agent when a conversation's owner is human or paused.
-
- messages object
1 fields
-
Where MARKETING templates go: auto = the Marketing Messages API once WhatsApp says the account is onboarded, else the Cloud API; cloud_api; mm_api.
autocloud_apimm_api
-
Responses
Fields
- success boolean
- request_id string
- settings object
The number's settings. GET answers every key with its default; PUT changes only the keys given (nested objects or dotted keys like "email.mark_read_on_open").
Fields: as the request body - keys string[]
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.
- 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.