Atualizar atributo do usuário

Versão 3.1.23.2

Atualizar uma definição de atributo do usuário.

Solicitação

PATCH /user_attributes/{user_attribute_id}
Tipo de dados
Descrição
Solicitação
HTTPRequest
path
HTTPPath
Expandir definição HTTPPath...
ID do atributo de usuário
integer
ID do atributo do usuário
body
Corpo HTTP
Expandir definição HTTPBody...
body
Atributo do usuário
Expandir definição do UserAttribute...
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
integer
ID exclusivo
nome
string
Nome do atributo do usuário
Rótulo
string
Rótulo humano para o atributo do usuário
tipo
string
Tipo de atributo de usuário ("string", "number", "datetime", "yesno", "zipcode")
default_value
string
Valor padrão quando nenhum valor é definido no usuário
sistema_is
booleano
O atributo é um padrão do sistema
is_permanente
booleano
O atributo é permanente e não pode ser excluído
valor_é_oculto
booleano
Se verdadeiro, os usuários não poderão ver os valores deste atributo.
user_can_view
booleano
Os usuários que não são administradores podem ver os valores dos atributos e usá-los em filtros.
user_can_edit
booleano
Os usuários podem alterar o valor desse atributo por conta própria
valor_do_domínio_oculto
string
Destinos para os quais um atributo oculto pode ser enviado. Uma vez definido, não pode ser editado.
consulta
Consulta HTTP
Expandir a definição de HTTPQuery...
campos
string
Campos solicitados.

Resposta

200: Atributo do usuário

Tipo de dados
Descrição
(objeto)
pode
objeto
Operações que o usuário atual pode realizar neste objeto
id
integer
ID exclusivo
nome
string
Nome do atributo do usuário
Rótulo
string
Rótulo humano para o atributo do usuário
tipo
string
Tipo de atributo de usuário ("string", "number", "datetime", "yesno", "zipcode")
default_value
string
Valor padrão quando nenhum valor é definido no usuário
sistema_is
booleano
O atributo é um padrão do sistema
is_permanente
booleano
O atributo é permanente e não pode ser excluído
valor_é_oculto
booleano
Se verdadeiro, os usuários não poderão ver os valores deste atributo.
user_can_view
booleano
Os usuários que não são administradores podem ver os valores dos atributos e usá-los em filtros.
user_can_edit
booleano
Os usuários podem alterar o valor desse atributo por conta própria
valor_do_domínio_oculto
string
Destinos para os quais um atributo oculto pode ser enviado. Uma vez definido, não pode ser editado.

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

422: erro de validação

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
Expandir a definição de ValidationErrorDetail...
campo
string
Campo com erro
código
string
Código do erro
mensagem
string
Mensagem de erro
url_da_documentação
string
Link da documentação
url_da_documentação
string
Link da documentação

429: Solicitações demais

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação