Restore archived contacts by id

Queues a restore of the archived contacts with the given ids. The contacts come back in the background, so the response only confirms the request; follow it with GET /contactArchives/restoreRequest/{id}. Only API users in the Admin group may call this; any other user gets 404. Every id must be an archived contact inside the restore window (see is_restorable on GET /contactArchives), or the whole request is refused with 400. When two selected archived contacts have the same email address, only the one with the highest id (normally the most recently archived) is restored. An empty ids list is accepted: it returns 201 and creates a restore request that matches no contacts, finishes without restoring anything, and never appears in GET /contactArchives/restoreRequest. Only one restore runs at a time: while one is running this returns 409. To restore every archived contact that matches a date range or a search, use POST /contactArchives/restoreAll.

Body Params
ids
array of int32s
required

Ids of the archived contacts to restore, as listed by GET /contactArchives.

ids*
Responses

404

The API user is not in the Admin group. The body is empty.

405

The method is not GET or POST. The body is empty.

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json