Digitalk Developers
  1. Tickets
Raiz
  • Raiz
  • CRM
    • CRM — Overview
    • Genérico (data)
      • CRM - Genérico
      • Listar/filtrar registros (qualquer tabela do CRM)
      • Criar/atualizar registros (qualquer tabela do CRM)
      • Hard-delete (não permitido para tabelas company)
    • Empresas Relacionadas
      • CRM - Empresas relacionadas
      • Tipos de relacionamento disponíveis
      • Listar relacionamentos de uma empresa (ambas as direções)
      • Criar relacionamento entre duas empresas
      • Alterar o tipo do relacionamento
      • Inativar relacionamento (reversível)
      • Excluir relacionamento (hard-delete)
    • Ticket ↔ Empresa
      • CRM - Ticket <-> Empresa
      • Empresas elegíveis para o ticket
      • Vincular / trocar a empresa do ticket
    • Templates
      • CRM - Templates
      • Listar templates do tenant (apenas IDs, sem fields)
      • Detalhe completo do template (com fields)
      • Pesquisa formatada por scope (CRMSearchResult)
  • Workflow
    • Workflow - Overview
    • Tickets
      • Workflow - Tickets
      • Detalhe completo do ticket (mensagens, SLA, fases, customer, empresa, business)
        GET
      • Criar ticket (básico, com integração CRM opcional)
        POST
      • Criar ticket com auto-vínculo / criação de customer via contato
        POST
      • Movimentar ticket entre fases (ou finalizar)
        POST
      • Atualizar dados do ticket (nome, descrição)
        PUT
      • Vincular cliente CRM a um ticket existente
        PUT
      • Adicionar nota ou mensagem ao ticket
        POST
    • Workspaces & Workflows
      • Workflow - Workspaces & Workflows
      • Listar workspaces e workflows acessíveis ao usuário
      • Listar fases de um workflow
      • Listar tickets de uma ou mais fases (paginado)
  1. Tickets

Criar ticket (básico, com integração CRM opcional)

POST
/api/v2/ticket
Última modificação:2026-05-28 20:05:32
Cria um ticket numa fase específica do workflow. Aceita opcionalmente
vincular um cliente CRM existente (via crm.id + table_name + column_name)
e um motivo de abertura (id_reason).
Pra criação com auto-descoberta/criação do cliente via contato, use
POST /api/v2/ticket/custom.

Campos do body#

CampoObrigatórioO que faz
namesimTítulo do ticket
descriptionsimDescrição
id_phasesimUUID da fase inicial (vem de GET /workflows/{id}/phases)
crmnãoVincula cliente CRM existente: { id, table_name, column_name }
id_reasonnãoMotivo de abertura (id numérico do motivo configurado no tenant)

Requisição

Parâmetros Header

Parâmetros Bodyapplication/jsonObrigatório

Examples
{
    "name": "Título do ticket",
    "description": "Descrição do ticket",
    "id_phase": "b5d7f8ab-3c76-43db-838c-73c54cc1e0f7"
}

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '/api/v2/ticket' \
--header 'api-key: {{api-key}}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Título do ticket",
    "description": "Descrição do ticket",
    "id_phase": "b5d7f8ab-3c76-43db-838c-73c54cc1e0f7"
}'

Respostas

🟢200OK
application/json
Ticket criado.
Bodyapplication/json

Exemplo
{
    "ok": true,
    "data": {
        "id": "84cefe00-761e-467c-9f77-fbb05ecb7af9",
        "id_seq": 484898,
        "name": "Título do ticket",
        "id_phase": "b5d7f8ab-3c76-43db-838c-73c54cc1e0f7"
    },
    "message": "Ticket aberto com sucesso."
}
🟠400Pedido Inválido
🟠401Não Autorizado
Modificado em 2026-05-28 20:05:32
Página anterior
Detalhe completo do ticket (mensagens, SLA, fases, customer, empresa, business)
Próxima página
Criar ticket com auto-vínculo / criação de customer via contato
Built with