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étodo | Rota | Content-Type |
|---|---|---|
POST | https://api.tomticket.com/v2.0/customer/permissions/access | form-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_AQUIParâ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
| Campo | Tipo | Obrigatório | Tamanho máximo | Descrição |
|---|---|---|---|---|
customer_id | string | Sim | 250 | Identificador 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. |
configuration | integer | Sim | 1 | Define se o cliente ficará ativo ou inativo. Opções: 1 - Ativo; 0 - Inativo. |
customer_type_id | string | Não | 1 | Tipo 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
| Campo | Tipo | Descrição |
|---|---|---|
error | boolean | Informa se ocorreu erro na operação. |
message | string | Mensagem de retorno da operação. |
success | boolean | Retorna true quando a operação é concluída com sucesso. |
Códigos HTTP
| Código | Descrição |
|---|---|
200 | Configuração de acesso alterada com sucesso. |
401 | Token inválido, parâmetro obrigatório não informado ou valor enviado não aceito pela API. |
403 | A operação não está disponível para a conta ou para o token informado. |
404 | Cliente não encontrado. |