Delete a custom field definition

DELETE

/api/v3/contacts/custom-fields/{fieldId}

const url = 'https://api.tryletterhead.com/api/v3/contacts/custom-fields/1';
const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"api":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.tryletterhead.com/api/v3/contacts/custom-fields/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "api": true }'

Deletes a company-level custom field definition. Values already stored under this key on individual contacts are left in place; they are simply no longer surfaced as a managed field.

Authorizations

bearerAuth

Parameters

Path Parameters

fieldId

required

integer

The field’s numeric identifier, from List custom field definitions.

Request Body^required

application/json

object

api

required

Required. Set to true to authenticate with an API key.

boolean

Example

{
  "api": true
}

Responses

200

Successful response

Still can’t find what you need? Contact support.