
Este método permite criar um novo cliente.
Endpoint
| Método | Rota | Content-Type |
|---|---|---|
POST | https://api.tomticket.com/v2.0/customer/new | 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 - Criar Cliente
| Campo | Tipo | Obrigatório | Tamanho máximo | Descrição |
|---|---|---|---|---|
customer_id | string | Sim | 250 | Identificador interno do cliente. Recomendamos utilizar um identificador que seja fácil associar aos dados de sua empresa, como uma chave primária em sistema, CPF ou CNPJ do cliente. |
name | string | Sim | 250 | Nome do cliente. |
email | string | Não | 250 | Endereço de email 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. Idiomas disponíveis: pt-BR (português do Brasil), es_ES (español), en-US (english). |
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. |
password | string | Não | 250 | Atualiza a senha do cliente. |
JSON de saída
JSON de saída - Criar 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 operaçã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 para uso. |
| 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. |