Custom attributes

List all custom attributes in an account

Get details of custom attributes in an Account

get/v1/workspaces/{workspace_id}/custom_attribute_definitions

Request

  • Base URL: https://api.oxvo.com
  • URL: https://api.oxvo.com/v1/workspaces/{workspace_id}/custom_attribute_definitions
  • Auth: API key in header api_access_token

Query parameters

attribute_model'0' | '1' required

conversation_attribute(0)/contact_attribute(1)

Response

Success

idinteger

Identifier

attribute_display_namestring

Attribute display name

attribute_display_typestring

Attribute display type (text, number, currency, percent, link, date, list, checkbox)

attribute_descriptionstring

Attribute description

attribute_keystring

Attribute unique key value

regex_patternstring

Regex pattern

regex_cuestring

Regex cue

attribute_valuesstring

Attribute values

attribute_modelstring

Attribute type(conversation_attribute/contact_attribute)

default_valuestring

Attribute default value

created_atstring

The date and time when the custom attribute was created

updated_atstring

The date and time when the custom attribute was updated

Changes

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