Criar Cliente

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

ChaveDescriçãoObrigatórioValor PadrãoTipoTamanho Máximo
customer_idIdentificador 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-String250
nameNome do cliente.Sim-String250
emailEndereço de email do cliente. Caso preenchido, pode ser usado pelo cliente para acessar o Painel do Cliente.Não-String250
phoneNúmero de telefone do cliente.Não-String20
create_tickets Permissão para criar chamados.
Opções disponíveis:

  • 1: Poderá criar chamados
  • 0: Criação de chamados desativada
Não1Int-
organization_idIdentificador da organização do cliente.Não-String512
languageIdioma do cliente ao acessar o Painel do Cliente.
Idiomas disponíveis:
  • pt-BR (português do Brasil)
  • es_ES (español)
  • en-US (english)
Nãopt-BRString5
portfolio_idIdentificador da carteira de clientes.
Este recurso somente está disponíveis para contas Enterprise.
Não-String512
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:

  • custom_field[ID-DO-CAMPO-01]: Valor Campo 01
  • custom_field[ID-DO-CAMPO-02]: Valor Campo 02
  • custom_field[ID-DO-CAMPO-N]: Valor Campo N
Variável-String1

Retorno

Descrição do retorno em JSON.

ColunaDescrição da ColunaTipo
errorInforma 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
messageDetalhes da operação, caso tenha ocorrido ou não um problema.String
successRetorna 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ódigoDescrição
200Operação realizada com sucesso.
401Token ou valores enviados não autorizados para uso.
403Recurso não disponível.
404Recurso não encontrado.

Disponibilidade

Recurso Premium Recurso Enterprise


Was this article helpful?  
We appreciate your review.