API reference
Update a confirmation
Change an order after it's created: a new delivery date or window, the items, the address, the customer's details and more.
/v1/confirmations/{id}Orders change: the delivery moves, the customer gives a new number, an item is swapped. Send only what's changed. Objects merge with what's there; arrays, such as order.items and order.rescheduleOptions, are replaced whole. The result is checked exactly like a create, so the same validation errors apply.
What you can change
orderobjectoptionalAny of
date,window,items,address,notes,ref,type,service,requiresSignatureandrescheduleOptions.customerobjectoptionalAny of
name,first,phoneandemail.channels, `smsVia`, `voice`, `cadence`, `brand`, `webhookUrl`, `externalId`optionalAs on create.
Anything else, such as status or outcome, can't be set and returns a 422.
What happens
| You change | What AnyoneIn does |
|---|---|
order.date or order.window | Starts a fresh plan for the new slot. Any answer the customer already gave is kept in history, outcome goes back to null, status to scheduled, and the customer is contacted again about the new day. You get a confirmation.updated webhook |
channels or cadence | Starts a fresh plan the same way |
| Anything else (address, items, notes, contact details) | Changes it in place. The plan and any outcome stay as they are, and the next message uses the new details |
If the customer has opted out, a new date is recorded but they aren't contacted, and the confirmation stays action_needed with an opt_out outcome.
Returns
200 OK with the updated confirmation, and warnings if anything you sent was dropped or adjusted.
Errors
| Status | code | When |
|---|---|---|
404 | not_found | No confirmation with that id for this key |
409 | conflict | It's cancelled (create a new one), or a call to the customer is in progress (try again in a few minutes) |
422 | validation_failed | A field isn't valid, the new date is in the past, or the field can't be changed |
Base URL https://api.anyonein.co.uk/v1, for test and live keys alike. Found a mistake? Tell us.