Permissão de Acesso e Situação do Cliente

Este endpoint permite ativar ou desativar o acesso de um cliente.

Essa configuração controla se o cliente poderá acessar o Painel do Cliente e criar chamados por e-mail.

Endpoint

MétodoRotaContent-Type
POSThttps://api.tomticket.com/v2.0/customer/permissions/accessform-data

Autenticação

Este endpoint utiliza autenticação Bearer Token.

Para utilizá-lo, é necessário possuir um Token de Acesso válido.

O token deve ser enviado no cabeçalho HTTP:

Authorization: Bearer SEU_TOKEN_AQUI

Parâmetros da requisição

Os parâmetros devem ser enviados no corpo da requisição utilizando form-data.

Parâmetros da requisição - Alterar acesso do cliente

CampoTipoObrigatórioTamanho máximoDescrição
customer_idstringSim250Identificador utilizado para localizar o cliente. Pode ser o identificador interno ou o endereço de e-mail cadastrado, conforme o valor de customer_type_id.
configurationintegerSim1Define se o cliente ficará ativo ou inativo. Opções: 1 - Ativo; 0 - Inativo.
customer_type_idstringNão1Tipo de identificador informado em customer_id. Opções: I - Identificador interno; E - Endereço de e-mail. Valor padrão: I.

JSON de saída

O retorno informa se a configuração de acesso do cliente foi alterada com sucesso.

JSON de saída - Alterar acesso do cliente

CampoTipoDescrição
errorbooleanInforma se ocorreu erro na operação.
messagestringMensagem de retorno da operação.
successbooleanRetorna true quando a operação é concluída com sucesso.

Códigos HTTP

CódigoDescrição
200Configuração de acesso alterada com sucesso.
401Token inválido, parâmetro obrigatório não informado ou valor enviado não aceito pela API.
403A operação não está disponível para a conta ou para o token informado.
404Cliente não encontrado.

Este artigo foi útil?  
Agradecemos sua avaliação.