Delete a form (archived when it has submissions)
https://api.app2email.com/v1/{number}/submit/forms/{key} Scope: submissions:manage. Not with a sandbox key. A form without submissions is deleted, and its WhatsApp version is retired: form messages already sent stop opening. A form that has submissions is never deleted, because they belong to it: it is archived instead (no longer offered, its submissions stay) and the answer says deleted false, archived true with a note. PUT /submit/forms/{key} {"archived": false} brings an archived form back.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The form's key (GET /submit/forms).
e.g.meter_reading
Responses
Fields
- success boolean
- request_id string
- deleted boolean
- key string
A form, list or connection: the key that was deleted.
- id integer
An automation: the id that was deleted.
- archived boolean
A form with submissions: it was archived, not deleted (deleted is false then).
- used_by string[]
A list: the keys of the forms that still name it.
- 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.
- 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.