v1Resources/Locations/postCancel a scheduled archival
Cancel a scheduled archival
Calls off a pending location archival, so a location scheduled to archive at the end of the billing period carries on as normal. Only works while the archival is still pending — a location that has already archived has to be reactivated instead.
post
locations:write/api/v1/locations/{id}/cancel-archiveQuery parameters
idstringrequired
The location whose pending archival should be cancelled.
Response
dataobjectoptional
cancelledbooleanoptional
Always true on success.
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/locations/{id}/cancel-archive
Your API key
id *
{
"data": {
"cancelled": true
}
}