Skip to main content
POST
/
api
/
v1
/
customer
/
support-cases
Create Support Case
curl --request POST \
  --url https://api.example.com/api/v1/customer/support-cases \
  --header 'Content-Type: application/json' \
  --data '
{
  "subject": "Problema na viagem",
  "description": "Preciso de ajuda com minha viagem.",
  "categoryId": "0197f151-0664-7b11-8a9c-a93acaf1ee22",
  "relatedOrderId": "0197a813-0fb9-7d42-9c81-50c0f6d9ae5a",
  "relatedTripReviewId": "0197a815-0fcf-704b-b703-f460b25515d4",
  "relatedSalesTicketId": "0197a813-a9a6-7752-8173-d40a2a2d0ef0",
  "relatedTripId": "0197a80f-2d8f-7710-b243-b67fb477a1c0"
}
'
{
  "supportCaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cooperativeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "openedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "assignedToUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "categoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "relatedOrderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "relatedTripReviewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "relatedSalesTicketId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "relatedTripId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "subject": "<string>",
  "description": "<string>",
  "resolvedAt": "2023-11-07T05:31:56Z",
  "closedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation.

Body

application/json

Support case payload.

subject
string
required

Subject.

Example:

"Problema na viagem"

description
string
required

Initial description.

Example:

"Preciso de ajuda com minha viagem."

categoryId
string<uuid> | null

Support category identifier.

Example:

"0197f151-0664-7b11-8a9c-a93acaf1ee22"

Related order identifier.

Example:

"0197a813-0fb9-7d42-9c81-50c0f6d9ae5a"

Related trip review identifier.

Example:

"0197a815-0fcf-704b-b703-f460b25515d4"

Related ticket identifier.

Example:

"0197a813-a9a6-7752-8173-d40a2a2d0ef0"

Related trip identifier.

Example:

"0197a80f-2d8f-7710-b243-b67fb477a1c0"

Response

Created

Chamado de suporte aberto por passageiro, empresa, cooperativa ou BKO

supportCaseId
string<uuid>
required

Identificador único

customerId
string<uuid> | null
required

Cliente/passageiro relacionado, quando aplicável

organizationId
string<uuid> | null
required

Organização relacionada ao chamado

companyId
string<uuid> | null
required

Empresa relacionada ao chamado

cooperativeId
string<uuid> | null
required

Cooperativa relacionada ao chamado

openedByUserId
string<uuid>
required

Usuário que abriu o chamado

assignedToUserId
string<uuid> | null
required

Usuário atualmente responsável pelo atendimento

categoryId
string<uuid> | null
required

Categoria do chamado

Pedido relacionado, quando aplicável

Avaliação relacionada, quando o chamado nasce do botão de contato na revisão

Passagem relacionada em Ticket, quando aplicável

Viagem relacionada, quando aplicável

code
string
required

Código legível único do chamado

scopeType
enum<string>
required

Escopo principal do chamado

Available options:
CUSTOMER,
COMPANY,
COOPERATIVE,
BACKOFFICE
priority
enum<string>
required

Prioridade operacional

Available options:
LOW,
MEDIUM,
HIGH,
URGENT
status
enum<string>
required

Status atual do chamado

Available options:
OPEN,
WAITING_CUSTOMER,
WAITING_SUPPORT,
RESOLVED,
CLOSED,
CANCELED
subject
string
required

Assunto curto do chamado

description
string
required

Descrição inicial do problema

resolvedAt
string<date-time> | null
required

Data de resolução

closedAt
string<date-time> | null
required

Data de fechamento

createdAt
string<date-time>
required

Data de criação

updatedAt
string<date-time>
required

Data da última atualização

deletedAt
string<date-time> | null
required

Data de remoção lógica