Atributos Personalizados

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

Modelos suportados (attribute_model)

O campo attribute_model define a que tipo de registro o atributo pertence: conversation_attribute (0), contact_attribute (1), company_attribute (2) e pipeline_card_attribute (3). Voce pode enviar o nome ou o id do enum. Atributos pipeline_card_attribute ficam disponiveis nos cards do Pipeline Pro e sao persistidos no JSONB custom_attributes de cada card (veja a API de Pipeline).

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, conversation_attribute, company_attribute ou pipeline_card_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 (array JSON)

json

[
  {
    "id": 1,
    "attribute_display_name": "Plano",
    "attribute_display_type": "list",
    "attribute_key": "segmento",
    "attribute_model": "contact_attribute",
    "attribute_values": ["lead", "vip", "conta-chave"]
  },
  {
    "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 (envolto em objeto custom_attribute_definition)

Nome	Tipo	Obrigatorio	Descricao
`attribute_display_name`	`string`	Sim	Nome exibido do atributo
`attribute_display_type`	`string`	Sim	Tipo: text, number, currency, percent, link, date, list, checkbox
`attribute_key`	`string`	Sim	Chave unica (snake_case)
`attribute_model`	`string \| integer`	Sim	Modelo do atributo. Aceita o nome (contact_attribute, conversation_attribute, company_attribute, pipeline_card_attribute) ou o id do enum: conversation_attribute=0, contact_attribute=1, company_attribute=2, pipeline_card_attribute=3.
`attribute_values`	`array`	Nao	Valores possiveis (para tipo list)
`attribute_description`	`string`	Nao	Descricao do atributo
`regex_pattern`	`string`	Nao	Padrao regex para validacao (tipo text)
`regex_cue`	`string`	Nao	Dica exibida quando a validacao regex falha

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 '{
    "custom_attribute_definition": {
      "attribute_display_name": "Plano",
      "attribute_display_type": "list",
      "attribute_key": "segmento",
      "attribute_model": "contact_attribute",
      "attribute_values": ["lead", "vip", "conta-chave"]
    }
  }'

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 (envolto em objeto custom_attribute_definition)

Nome	Tipo	Obrigatorio	Descricao
`attribute_display_name`	`string`	Nao	Nome exibido
`attribute_description`	`string`	Nao	Descricao
`attribute_values`	`array`	Nao	Valores possiveis
`regex_pattern`	`string`	Nao	Padrao regex de validacao
`regex_cue`	`string`	Nao	Dica de validacao regex

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"