Delete a custom activity (delete)

The delete Ortto endpoint of the activity entity is used to archive one or more custom activities in Ortto’s customer data platform (CDP).

Custom activities must be archived before they can be deleted. Once the activity has been archived via the API call, you can delete it in the Ortto app.

This page provides descriptions of this endpoint’s:

• request resource and method,
• valid parameters, headers, and request body values, as well as
• the response payload.

HTTP method and request resources

 
DELETE https://api.ap3api.com/v1/definitions/activity/delete

Path and query parameters

This endpoint takes no additional path and/or query parameters.

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 with the valid elements listed in the table below.

The following JSON object is an example of a request to archive a custom activity definition in your Ortto account’s CDP.

Example custom activity definition request body

json
 
{
"activity_field_id": "act:cm:act1"
}

Valid request body elements

The following table lists all valid request body elements (arrays, objects, or fields), which are available to this endpoint.

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 people’s data that Ortto retrieves from your Ortto account’s CDP after a request to this endpoint.

Example delete custom activity definition response payload from Ortto’s CDP

json
 
{
    "archived_activity": "act:cm:act1"
}

Response payload elements

The following table lists all elements (arrays, objects, or fields) in the response from a request to this endpoint.