Skip to main content
PATCH
Atualizar custom attribute em conta

Autorizações

api_access_token
string
header
obrigatório

Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

id
number
obrigatório

ID do atributo personalizado

account_id
integer
obrigatório

O ID numérico da conta

Corpo

application/json
attribute_display_name
string

Nome de exibição do atributo

Exemplo:

"Custom Attribute"

attribute_display_type
integer

Tipo de exibição do atributo (text- 0, number- 1, currency- 2, percent- 3, link- 4, date- 5, list- 6, checkbox- 7)

Exemplo:

0

attribute_description
string

Descrição do atributo

Exemplo:

"This is a custom attribute"

attribute_key
string

Valor de chave exclusiva do atributo

Exemplo:

"custom_attribute"

attribute_values
string[]

Valores de atributo

Exemplo:
attribute_model
integer

Tipo de atributo (conversation_attribute- 0, contact_attribute- 1)

Exemplo:

0

regex_pattern
string

Padrão de expressão regular (Apenas aplicável para o tipo- text). O padrão de expressão regular é usado para validar o(s) valor(es) do atributo.

Exemplo:

"^[a-zA-Z0-9]+$"

regex_cue
string

Mensagem de dica da expressão regular (Apenas aplicável para o tipo- text). A mensagem de dica é mostrada quando o padrão da expressão regular não corresponde.

Exemplo:

"Please enter a valid value"

Resposta

Sucesso

id
integer

Identificador

attribute_display_name
string

Nome de exibição do atributo

attribute_display_type
string

Tipo de exibição do atributo (text, number, currency, percent, link, date, list, checkbox)

attribute_description
string

Descrição do atributo

attribute_key
string

Valor de chave exclusiva do atributo

regex_pattern
string

Padrão de expressão regular (regex)

regex_cue
string

Dica de expressão regular (regex cue)

attribute_values
string

Valores de atributo

attribute_model
string

Tipo de atributo (conversation_attribute/contact_attribute)

default_value
string

Valor padrão do atributo

created_at
string

A data e hora em que o atributo personalizado foi criado

updated_at
string

A data e hora em que o atributo personalizado foi atualizado