Criar Organização

Este método permite criar uma organização. 


Endpoint

https://api.tomticket.com/v2.0/organization/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
nameNome da organização.Sim-String250
emailEndereço de email da organização.Não-String250
manager_see_all_tickets
Permissão para os gerentes da organização poderem visualizar chamados de seus membros.
Opções Disponíveis:

0 - Não Permite
1 - Permite
Não
1
Int
-
create_tickets
Permissão para criar chamados.
Opções Disponíveis:

0 - Não Permite
1 - Permite
Não
1
Int
-
team_see_all_tickets
Permissão para os membros da organização poderem visualizar chamados de outros membros.
Opções Disponíveis:

0 - Não Permite
1 - Permite
Não
1
Int
-
monthly_tickets_quota
Cota mensal para criação de chamados.Não
-
Int
-
mother_organization_idIdentificador da organização matriz.Não
-String512
portfolio_idIdentificador da carteira de clientes.Não
-String512
custom_field[id]Campo personalizado para cadastro de organização.

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-String-
strict_name
Restringe o cadastro de organizações se já houver uma organização usando o nome enviado.
Opções Disponíveis:

0 - Não Restringe
1 - Restringe
Não
0
String
1
strict_mail
Restringe o cadastro de organizações se já houver uma organização usando o endereço de email enviado.
Opções Disponíveis:

0 - Não Restringe
1 - Restringe
Não
0
String
1
return_id_if_exists
Define se será retornado o identificador da organização se houver uma organização usando o nome ou endereço de email enviado. E se a opção strict_name e strict_mail foram enviadas como verdadeiras.

0 - Não Retorna
1 - Retorna
Não
0
String
1

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
idRetorna o identificador da nova organização criada.String

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.