Delete custom field - Ortto Knowledge Base | Help Center & Documentation

The delete Ortto endpoint of the custom-field entity is used to delete custom contact (person) or account (previously organization) fields in Ortto's customer data platform (CDP).

NOTE: This endpoint follow the same rules/limits seen when deleting a field on the Ortto app. It is not possible to bulk delete custom fields as this endpoint only supports deleting a single field.

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 endpoint


 DELETE https://api.ap3api.com/v1/instances/custom-field/delete

NOTE: Ortto customers who have their instance region set to Australia or Europe will need to use specific service endpoints relative to the region:

Australia: https://api.au.ap3api.com/
Europe: https://api.eu.ap3api.com/

For example: https://api.eu.ap3api.com/v1/<entity/endpoint>

All other Ortto users will use the default service endpoint (https://api.ap3api.com/).

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 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 delete a custom field in your Ortto account’s CDP.

Example delete custom field request body from Ortto’s CDP

json
 {
    "field_id": "str:cm:my-custom-field"
}

Payload elements

The following table lists all elements supported in this payload.

Element	Description
`field_id`	The field ID for the custom field. Learn more about Ortto’s person fields.

Response payload

A 200 response indicates the custom contact (person) or account (previously organization) field has been deleted. It is expected for the body of the response payload to be empty.