Change a contact
https://api.app2email.com/v1/{number}/contacts/{identity} Needs the 'contacts:manage' scope. The same fields as POST /contacts; only the ones given change.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The contact's number (country code first), or their business-scoped user id.
e.g.61412345678
Body application/json required
- phone stringe.g.
61412345678 - identity string
Instead of phone: a number or a business-scoped user id.
e.g.61.AbC123xyz - e.g.
John Smith -
Up to 50 text values (names: letters, digits, underscores). Used as named template values in segment sends.
e.g.{"order_id":"1234","first_name":"John"} - e.g.
crm - consent object
Consent to marketing messages, with the evidence the Spam Act 2003 expects you to keep.
5 fields
- marketing boolean
true: consented. false: withdrawn (add them to the Do Not Call list too).
- at string (date-time)
When. Now when left out.
- e.g.
web form -
The wording the contact agreed to.
e.g.Yes, send me offers on WhatsApp -
A link, file name, IP address or message id that proves it.
e.g.https://example.com/forms/123
Responses
Fields
- success boolean
- request_id string
- contact object
12 fields
- identity stringe.g.
61412345678 - identity_type string
phonebsuid - phone string
- name string
- source string
- consent object
- last_inbound_at string (date-time)
- last_outbound_at string (date-time)
- created string (date-time)
- updated string (date-time)
- created boolean
- note 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.