API reference
Advance a confirmation
Sends the next pending step now, instead of waiting for its scheduled time.
/v1/confirmations/{id}/advanceBrings the next pending step forward so it goes out straight away: the text instead of waiting for tomorrow, or the call instead of waiting for the afternoon. It's what the "send the next step now" button in the console does.
Path parameters
idstringrequiredThe confirmation's
id.
Returns
200 OK with the updated confirmation. The next pending step's dueAt is now, and a system event records that it was brought forward. The step itself goes out within a few seconds; retrieve the confirmation, or wait for the outcome webhook, to see the result.
Only the next step moves. Later steps keep their times.
Important
An advanced step goes out immediately, even outside the usual contact hours. Use it when someone on your team has decided a customer should be contacted now.
Errors
| Status | error | When |
|---|---|---|
404 | No confirmation with that id. | The id doesn't exist |
409 | This confirmation is already closed. | It's confirmed, rescheduled, action_needed, unreachable or cancelled |
409 | Nothing left to send. | Every step has already gone out |
Base URL https://api.anyonein.co.uk/v1 is a placeholder until the production domain is confirmed. Found a mistake? Tell us.