Atributos Personalizados

Defina atributos personalizados para contatos e conversas. Esses atributos podem ser usados em filtros, automacoes e relatorios.

GET/api/v1/accounts/{account_id}/custom_attribute_definitions

Lista todos os atributos personalizados da conta.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`attribute_model`(query)	`string`	Nao	Filtrar por modelo: contact_attribute ou conversation_attribute

bash

curl -s "https://chat.seudominio.com/api/v1/accounts/1/custom_attribute_definitions?attribute_model=contact_attribute" \
  -H "api_access_token: YOUR_TOKEN" | jq .

200Lista de atributos

json

{
  "data": [
    {
      "id": 1,
      "attribute_display_name": "Plano",
      "attribute_display_type": "list",
      "attribute_key": "plano",
      "attribute_model": "contact_attribute",
      "attribute_values": ["free", "pro", "enterprise"]
    },
    {
      "id": 2,
      "attribute_display_name": "CNPJ",
      "attribute_display_type": "text",
      "attribute_key": "cnpj",
      "attribute_model": "contact_attribute"
    }
  ]
}

POST/api/v1/accounts/{account_id}/custom_attribute_definitions

Cria um novo atributo personalizado.

Body

Nome	Tipo	Obrigatorio	Descricao
`attribute_display_name`	`string`	Sim	Nome exibido do atributo
`attribute_display_type`	`string`	Sim	Tipo: text, number, link, date, list, checkbox
`attribute_key`	`string`	Sim	Chave unica (snake_case)
`attribute_model`	`string`	Sim	Modelo: contact_attribute ou conversation_attribute
`attribute_values`	`array`	Nao	Valores possiveis (para tipo list)
`attribute_description`	`string`	Nao	Descricao do atributo

bash

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/custom_attribute_definitions" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "attribute_display_name": "Plano",
    "attribute_display_type": "list",
    "attribute_key": "plano",
    "attribute_model": "contact_attribute",
    "attribute_values": ["free", "pro", "enterprise"]
  }'

GET/api/v1/accounts/{account_id}/custom_attribute_definitions/{id}

Retorna detalhes de um atributo personalizado.

PATCH/api/v1/accounts/{account_id}/custom_attribute_definitions/{id}

Atualiza um atributo personalizado.

Body

Nome	Tipo	Obrigatorio	Descricao
`attribute_display_name`	`string`	Nao	Nome exibido
`attribute_description`	`string`	Nao	Descricao
`attribute_values`	`array`	Nao	Valores possiveis

DELETE/api/v1/accounts/{account_id}/custom_attribute_definitions/{id}

Remove um atributo personalizado. Dados existentes nos contatos nao serao afetados.

bash

curl -X DELETE "https://chat.seudominio.com/api/v1/accounts/1/custom_attribute_definitions/1" \
  -H "api_access_token: YOUR_TOKEN"