Update a custom field definition
PUT
/api/v3/contacts/custom-fields/{fieldId}
const url = 'https://api.tryletterhead.com/api/v3/contacts/custom-fields/1';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"api":true,"label":"Preferred color"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.tryletterhead.com/api/v3/contacts/custom-fields/1 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "api": true, "label": "Preferred color" }'Updates an existing custom field definition. Only the fields you pass are changed.
This is a company-level (v3) write. Authenticate with a company API key as a Bearer token.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” fieldId
required
integer
The field’s numeric identifier, from List custom field definitions.
Request Body required
Section titled “Request Body required ” Media type application/json
object
api
required
Required. Set to true to authenticate with an API key.
boolean
name
string
label
string
type
text, number, boolean, or date.
string
required
boolean
sortOrder
integer
Example
{ "api": true, "label": "Preferred color"}Responses
Section titled “ Responses ”Custom field definition updated.
Still can’t find what you need? Contact support.