Este método permite a criação de artigos para a base de conhecimento.
Endpoint
| Método | Rota | Content-Type |
|---|
POST | https://api.tomticket.com/v2.0/kb/article/new | form-data |
Autenticação
Este endpoint utiliza autenticação Bearer Token.
Authorization: Bearer SEU_TOKEN_AQUI
Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso.
Parâmetros da requisição
Parâmetros da requisição - Criar Artigo
| Campo | Tipo | Obrigatório | Tamanho máximo | Descrição |
|---|
title | string | Sim | - | Título do artigo. |
content | string | Sim | - | Conteúdo do artigo em HTML. O texto será sanitizado preservando apenas as tags já permitidas pelo projeto. |
visibility | string | Sim | - | Define quem pode visualizar o artigo. Valores permitidos: customers_and_agents, registered_customers_and_agents ou agents. |
category_id | string | Sim | - | Hash identificador da categoria desejada. |
display_order | integer | Não | - | Ordem de exibição do artigo dentro da base de conhecimento ou categoria. |
JSON de saída
JSON de saída - Criar Artigo
| Campo | Tipo | Descrição |
|---|
error | boolean | Informa se ocorreu um erro na operação. |
message | string | Detalhes da operação, caso tenha ocorrido ou não um problema. |
success | boolean | Informa se tudo ocorreu com sucesso. |
data | object | Dados retornados na criação do artigo. |
article_id | string | Hash identificador do artigo recém-criado. |
title | string | Título do artigo criado. |
Possíveis erros
| Status HTTP | Mensagem | Quando ocorre |
|---|
401 | Token ou valores enviados não autorizados para uso. | Quando o token ou os valores enviados não estão autorizados para uso. |
403 | Recurso não disponível. | Quando o recurso não está disponível. |
404 | Recurso não encontrado. | Quando o recurso não é encontrado. |
Código 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. |
Agradecemos sua avaliação.