Run a manual automation on a submission
https://api.app2email.com/v1/{number}/submit/submissions/{id}/run Scope: submissions:manage. Not with a sandbox key. Runs one automation whose trigger is manual on this submission now: the same thing as its button in the inbox. automation_id is one of the submission's actions[].id (GET /submit/submissions/{id}); the automation must be switched on and belong to the submission's form (400 invalid_automation otherwise). The automation's conditions are still checked. The answer is the run with every step: what was sent to an outside system and what came back. A step that fails is inside the run (steps[].ok false, status failed), not an error of this call; when the server is busy the run is queued (status waiting) and shows in GET /submit/runs. Whatever the actions do is real: replies are sent, stages change, systems are called.
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
-
A manual automation of the submission's form: one of the submission's actions[].id.
e.g.31
Responses
Fields
- success boolean
- request_id string
- run object
One run of an automation on one submission, with every step.
13 fields
- id integer
0 for a try: it is not stored.
- automation_id integer
- automation string
Its name.
- submission string
The submission's reference.
- trigger string
- status string
ok: it ran to the end; an action that did not work without stopping the run (a refused stage, a reply that could not be sent) has ok false in its step and its message in error. failed: an outside call ran out of retries, or failed with on_fail stop. waiting: paused by a wait action, between retries, or queued (due says when it continues). skipped: the conditions did not hold, or the automation or the submission was gone.
runningokfailedwaitingskipped - attempt integer
- steps object[]
9 item fields
- n integer
The action's number in the automation, counted from 1.
- type string
The action type.
- ok boolean
- ms integer
- summary string
What happened, in words.
- error string
-
Outside calls only: method, address and what was sent. Never a secret or a sign-in header.
-
Outside calls only: status and the first 2,000 characters of the answer.
- try integer
Only on a retry of an outside call: 2, 3 or 4.
- error string
- test boolean
true: a try, nothing was changed or sent.
- created string (date-time)
- finished string (date-time) | null
- due string (date-time) | null
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.