Este método permite criar um novo cliente.
Endpoint
https://api.tomticket.com/v2.0/customer/new
Método HTTP
POST
Content Type
form-data
Autenticação
Authorization: Bearer {SEU-TOKEN-AQUI}
Parâmetros de Requisição
| Chave | Descrição | Obrigatório | Valor Padrão | Tipo | Tamanho Máximo |
|---|---|---|---|---|---|
customer_id | 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. | Sim | - | String | 250 |
name | Nome do cliente. | Sim | - | String | 250 |
email | Endereço de email do cliente. Caso preenchido, pode ser usado pelo cliente para acessar o Painel do Cliente. | Não | - | String | 250 |
phone | Número de telefone do cliente. | Não | - | String | 20 |
create_tickets | Permissão para criar chamados. Opções disponíveis:
| Não | 1 | Int | - |
organization_id | Identificador da organização do cliente. | Não | - | String | 512 |
language | Idioma do cliente ao acessar o Painel do Cliente. Idiomas disponíveis:
| Não | pt-BR | String | 5 |
portfolio_id | Identificador da carteira de clientes. Este recurso somente está disponíveis para contas Enterprise. | Não | - | String | 512 |
custom_field[id] | Campo personalizado para cadastro de cliente. O campo poderá ser obrigatório dependendo da configuração do cadastro do campo personalizado. Exemplo:
| Variável | - | String | 1 |
Retorno
Descrição do retorno em JSON.
| Coluna | Descrição da Coluna | Tipo |
|---|---|---|
| error | Informa se ocorreu um erro na operação. Se o retorno for false, então significa que a operação ocorreu com sucesso e não ocorreram problemas. Caso o retorno seja true, ocorreu um erro e será necessário verificar o campo mensagem para identificar o problema. | Boolean |
message | Detalhes da operação, caso tenha ocorrido ou não um problema. | String |
success | Retorna true caso a operação tenha sido concluída com sucesso. | Boolean |
Código de Retorno
Descrição do código HTTP de retorno.
| Código | Descrição |
|---|---|
| 200 | Operação realizada com sucesso. |
| 401 | Token ou valores enviados não autorizados para uso. |
| 403 | Recurso não disponível. |
| 404 | Recurso não encontrado. |
Disponibilidade
