Synup
Create a key
v1Resources/Clients/postReactivate an archived client

Reactivate an archived client

Restores an already-archived client, and every location that archived along with it. A client that isn't currently archived is a no-op success, not an error. This is the only way back for a client with outcome archived — one that's still scheduled should go through cancel-archive instead.

post/api/v1/clients/{id}/reactivate
clients:write
Query parameters
idstringrequired
The client to reactivate.
Response
dataobjectoptional
archivedbooleanoptional
Whether the client is archived.
locationsArchivednumberoptional
Number of locations archived along with the client. Present only when outcome is archived.
locationsFailednumberoptional
Number of locations that failed to archive. Present only when outcome is archived.
cancelledScheduledPostsnumberoptional
Number of scheduled posts cancelled as part of archiving. Present only when outcome is archived.
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.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/clients/{id}/reactivate
Your API key
id *
{
  "data": {
    "archived": false,
    "locationsArchived": 1,
    "locationsFailed": 0,
    "cancelledScheduledPosts": 0
  }
}

Guides that use this resource