latestOpenAPI 3.0.02026-08-10416661.5 MB

e96b3e58b041

Custom Fields

Update custom field

REQUIRED SCOPES <code>['custom-fields:write']</code><br>This API request allows for modifying data for a specific custom field by id specified in path. <br><br>Properties that you can update are the name of a specific custom field and value type of a specific custom field (text, URL, date, number). <br><br>Additionally, you can update the feature that shows or does not show specific custom fields in сonversations.

put/custom-fields/field/{customField}

Path parameters

customFieldinteger required

Custom field id

Query parameters

namestring required
Example:First Name

Field name

type'text' | 'url' | 'date' | 'number' required
Example:text

Type

visibleboolean required

Show in сonversations

Response

OK

statusstring