latestOpenAPI 3.0.02026-08-10416661.5 MB

e96b3e58b041

Custom Fields

Create custom field

REQUIRED SCOPES <code>['custom-fields:write']</code><br>In addition to the 4 fields available by default (First name, Last name, Phone Number, Email address), this API endpoint allows for creating and adding a new custom field to the ones that already exist. <br><br>As a result, each user in the system can now narrow down the search among their contacts and individualize messages. <br><br>To create a new custom field for your contacts, you have two things to select: <strong>Field Name</strong> which is a recognizable title for your custom property (i.e Birthday) and <strong>Field Type.</strong> <br><br>The values that are allowed for Field Types include: <ul> <li>Text</li> <li>URL</li> <li>Date</li> <li>Number</li> </ul> <p>As a result, inside the conversation window, on the user contact card, there’s new data available for view. You can choose whethe to show custom information on the user contact card or not.</p>

post/custom-fields/field

Query parameters

namestring required
Example:First Name

Field name

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

Type

visibleboolean required

Show in сonversations

Response

OK

statusstring