Write an internal note on a submission
https://api.app2email.com/v1/{number}/submit/submissions/{id}/notes Scope: submissions:manage. Not with a sandbox key. A note for the team, up to 4,000 characters. The submitter never sees it. It appears in the activity list under the key's name, submission.note_added is sent, and automations with the trigger note_added run.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The submission's id, or its reference (MR-7Q3M2A).
e.g.MR-7Q3M2A
Body application/json required
- e.g.
The customer called: the meter was replaced in October.
Responses
Fields
- success boolean
- request_id string
- event object
One line of a submission's activity list. The list only grows.
7 fields
- id integer
- kind string
creatededitedstatusassignedprioritytagsduenotereply_outreply_infilelocationbuttonautomationfollowupvieweddeletedrestorederror - actor object
Who did it.
- text string
-
Details by kind, for example {from, to} of a stage change or {state: sent | held | email | failed} of a reply.
- public boolean
true: the submitter sees it on their status page.
- created string (date-time)
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.
- 415 The body is not JSON.
- 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.