Add a new custom attribute

Add a new custom attribute to account

Authorization

userApiKey

api_access_token<token>

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

In: header

Path Parameters

account_id*integer

The numeric ID of the account

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

attribute_display_name?string

Attribute display name

attribute_display_type?integer

Attribute display type (text- 0, number- 1, currency- 2, percent- 3, link- 4, date- 5, list- 6, checkbox- 7)

attribute_description?string

Attribute description

attribute_key?string

Attribute unique key value

attribute_values?array<string>

Attribute values

attribute_model?integer

Attribute type(conversation_attribute- 0, contact_attribute- 1)

regex_pattern?string

Regex pattern (Only applicable for type- text). The regex pattern is used to validate the attribute value(s).

regex_cue?string

Regex cue message (Only applicable for type- text). The cue message is shown when the regex pattern is not matched.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/accounts/0/custom_attribute_definitions" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": 0,
  "attribute_display_name": "string",
  "attribute_display_type": "string",
  "attribute_description": "string",
  "attribute_key": "string",
  "regex_pattern": "string",
  "regex_cue": "string",
  "attribute_values": "string",
  "attribute_model": "string",
  "default_value": "string",
  "created_at": "string",
  "updated_at": "string"
}

{
  "description": "string",
  "errors": [
    {
      "field": "string",
      "message": "string",
      "code": "string"
    }
  ]
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

403application/json

`application/json`

`application/json`