Message

Get custom message fields

Gets a list of all custom fields defined for messages in this project. The return value is an array of objects with the properties 'name', 'variable', 'type', 'order', and 'hide_values'. (Fields are automatically created any time a Message's 'vars' property is updated.)

get/v1/projects/{project_id}/message_fields

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/message_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

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

hide_valuesboolean

Whether to hide field values in the web app

Changes

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