Contact

Update custom contact fields

Updates metadata for one or more custom contact fields. Only the specified fields are updated; other fields are not affected.

To delete a field, include an object with the variable and delete properties set (e.g. {"variable": "my_field", "delete": true}). Deleting a field will also clear the corresponding variable on all contacts in the project.

post/v1/projects/{project_id}/contact_fields

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/contact_fields
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

Request body

Response

Successful response

namestring

Display name of the field

variablestring

Variable name used in the API

typestring

Field type

orderinteger

Display order of the field

readonlyboolean

Whether the field is read-only

lookup_keyboolean

Whether the field is a lookup key

show_on_conversationboolean

Whether to show field on Conversations tab

Changes

No recorded changes to this operation across all 1 revision of this API.