
Este método permite atualizar os dados de um cliente.
Endpoint
| Método | Rota | Content-Type |
|---|---|---|
POST | https://api.tomticket.com/v2.0/customer/update | form-data |
Autenticação
Este endpoint utiliza autenticação Bearer Token.
Authorization: Bearer SEU_TOKEN_AQUICaso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso.
Parâmetros da requisição
Parâmetros da requisição - Atualizar Informações do Cliente
| Campo | Tipo | Obrigatório | Tamanho máximo | Descrição |
|---|---|---|---|---|
customer_id | string | Sim | 250 | Identificador interno do cliente para realizar a busca e atualização das informações. Pode ser o endereço de e-mail do cadastro ou o identificador interno utilizado. |
customer_type_id | string | Não | 1 | Tipo de identificador utilizado para localizar o cliente. Valores: I - Identificador interno; E - E-mail. |
name | string | Não | 250 | Nome do cliente. |
email | string | Não | 250 | Endereço de e-mail do cliente. Caso preenchido, pode ser usado pelo cliente para acessar o Painel do Cliente. |
phone | string | Não | 20 | Número de telefone do cliente. |
create_tickets | integer | Não | - | Permissão para criar chamados. Opções disponíveis: 1 - poderá criar chamados; 0 - criação de chamados desativada. |
organization_id | string | Não | 512 | Identificador da organização do cliente. |
language | string | Não | 5 | Idioma do cliente ao acessar o Painel do Cliente. Valores disponíveis: pt-BR, es_ES e en-US. |
portfolio_id | string | Não | 512 | Identificador da carteira de clientes. Este recurso somente está disponível para contas Enterprise. |
custom_field[id] | string | Não | 1 | Campo personalizado para cadastro de cliente. O campo poderá ser obrigatório dependendo da configuração do cadastro do campo personalizado. |
internal_id | string | Não | - | Identificador interno do cliente. Só poderá ser informado se o customer_type_id informado for E (E-mail). |
password | string | Não | 250 | Cria a senha do cliente. |
JSON de saída
JSON de saída - Atualizar Informações do Cliente
| Campo | Tipo | Descrição |
|---|---|---|
error | boolean | Informa se ocorreu um erro na operação. |
message | string | Detalhes da operação, caso tenha ocorrido ou não um problema. |
success | boolean | Retorna true caso a operação tenha sido concluída com sucesso. |
Possíveis erros
| Status HTTP | Mensagem | Quando ocorre |
|---|---|---|
| 200 | Operação realizada com sucesso. | Quando a atualização é concluída com sucesso. |
| 401 | Token ou valores enviados não autorizados para uso. | Quando o token ou os valores enviados não são autorizados. |
| 403 | Recurso não disponível. | Quando o recurso não está disponível. |
| 404 | Recurso não encontrado. | Quando o recurso não é encontrado. |
Qualquer propriedade enviada vazia será alterada no cadastro do cliente. Se uma propriedade não for enviada, ela não será modificada.