Synup
Create a key
v1Resources/Locations/postSchedule a location to archive

Schedule a location to archive

SCHEDULES a location to archive at the end of the current billing period. The location stays fully active, billable, and still counts against the plan's location limit until then — nothing is deleted, and scheduling does not free room to add another location until it actually archives. Call cancel-archive to call this off before it lands, or reactivate afterward to bring the location back.

post/api/v1/locations/{id}/archive
locations:write
Query parameters
idstringrequired
The location to schedule for archival.
Response
dataobjectoptional
scheduledbooleanoptional
Always true on success.
scheduledArchiveAtstringoptional
When archival was requested (also the token cancel-archive matches on), as an ISO 8601 timestamp, or null if none is pending.
archiveAtstringoptional
When the scheduled archival will actually land — the agency's billing boundary. Null if the agency has none.
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}/archive
Your API key
id *
{
  "data": {
    "scheduled": true,
    "scheduledArchiveAt": "2026-02-01T00:00:00.000Z",
    "archiveAt": "2026-03-01T00:00:00.000Z"
  }
}