Delete a contact record
https://api.app2email.com/v1/{number}/contacts/{identity} Needs the 'contacts:manage' scope. The Do Not Call list and the opt-ins are separate records and stay. The contact's appointments (and notes, payments, packages) are kept: add booking_data=erase to erase or anonymise them too (future confirmed appointments are cancelled without a message, every appointment loses the customer's name, number, e-mail and notes, and their notes, links, holds and poll votes are deleted; the answer then carries booking_data_erased with the counts, and booking.customer.erased is sent). That cannot be undone. With booking_data=erase the contact's ticket data is erased too (orders and tickets lose the name, number, email and answers; old ticket links stop working); the answer then carries ticket_data_erased with the counts and ticket.buyer.erased is sent. It is refused, with the reason in note, while the contact holds a valid ticket for a coming date.
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
Query
- booking_data string
erase: also erase the contact's booking data (appointments, notes, links, holds, poll votes, package and payment details). Left out: the appointments are kept.
erase
Responses
Fields
- success boolean
- request_id string
- deleted string
- 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.