Archive, restore and delete people (archive, restore, delete)
The archive
, restore
and delete
Ortto endpoints of the person
entity are used to archive, restore and delete one or more people records in Ortto’s customer data platform (CDP).
Learn more about archiving, restoring and deleting people under Archiving and deleting people.
This page provides descriptions of these endpoint:
-
valid parameters, headers, and request body values, as well as
-
the response payloads.
HTTP method and request resources
PUT https://api.ap3api.com/v1/person/archive
PUT https://api.ap3api.com/v1/person/restore
DELETE https://api.ap3api.com/v1/person/delete
Contacts must be archived before they can be restored or deleted. |
Ortto customers who have their instance region set to Australia or Europe will need to use specific service endpoints relative to the region:
For example: https://api.eu.ap3api.com/v1/<entity/endpoint> All other Ortto users will use the default service endpoint (https://api.ap3api.com/). |
Headers
This endpoint requires a custom API key and content type (application/json
for the request body) in the header of the request:
-
X-Api-Key: CUSTOM-PRIVATE-API-KEY
-
Content-Type: application/json
Request body
The request body consists of a JSON object whose valid elements are listed in the table below.
The following JSON object is an example of field and object data that Ortto can recognize to archive, restore or delete one or more contact records in your Ortto account’s CDP.
{
"inclusion_ids": [
"00609384fa6de6e7a8d89d01"
]
}
Valid request body elements
The following table lists all valid request body elements (arrays, objects, or fields), which are available to these endpoints.
Element | Type | Description |
---|---|---|
|
|
A list of contacts to archive/restore/delete. You can obtain the contact ID using the |
|
A list of contacts to exclude from the archive/restore/delete request. |
|
|
|
Setting When used to archive people, A request body to bulk archive/restore/delete looks like:
|
Response payload
The response payload consists of a JSON object with the elements listed in the table below.
The following JSON object is an example of the person data that Ortto retrieves from your Ortto account’s CDP after a request to these endpoints.
{
"scheduled_contacts": 0,
"archived_contacts": 35
}
Response payload elements
The following table lists all elements (arrays, objects, or fields) in the response from a request to these endpoints.
Element | Type | Description |
---|---|---|
|
|
The value indicates the number of contacts that are scheduled to be archived/restored/deleted shortly after the API call. |
|
|
The value indicates the number of contacts that were archived during the API call. |
|
|
The value indicates the number of contacts that were restored during the API call. |
|
|
The value indicates the number of contacts that were deleted during the API call. |