> ## Documentation Index
> Fetch the complete documentation index at: https://docs.escrybe.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancelar um pedido



## OpenAPI

````yaml /openapi/escrybe.pt.yaml delete /api/v2/delete/{securityToken}/{job_id}
openapi: 3.1.0
info:
  title: API Escrybe
  version: 1.0.0
  description: >-
    REST API da plataforma Escrybe — envie cartas físicas, cartas registradas,

    telegramas e e-Carta pelos Correios, dispare e-mails registrados
    juridicamente

    e envie mensagens de WhatsApp com carimbo de tempo certificado.



    ## Autenticação


    Toda conta possui um **`securityToken`** pessoal (disponível no painel em

    *Minhas configurações → Acesso a API*). Três produtos o utilizam de formas

    diferentes:



    | Produto | Esquema | Como |

    |---------|---------|------|

    | Cartas / Telegrama / e-Carta, E-mail Registrado, Recibos | Token de API |
    Envie `userSecurityToken` como parâmetro (query/body) ou `securityToken`
    como header |

    | WhatsApp | HTTP Basic | `Authorization: Basic base64(email:securityToken)`
    |



    > As rotas de **consulta** de carta e e-mail (`get`, `balance`, `download`,

    > `delete`) recebem o token como o primeiro segmento de **caminho** da URL —

    > ex.: `/api/v2/get/{securityToken}/{job_id}`.



    ## Envelopes de resposta


    A maioria dos endpoints responde com o envelope padrão

    `{"status": <código http>, "status_message": "...", "data": ...}` — isso
    cobre

    Cartas/Telegrama, E-mail Registrado e os endpoints de mensagens e remetentes
    de

    WhatsApp. Os endpoints de **modelos** de WhatsApp (e a sincronização de
    modelos)

    usam `{"code": <código http>, "status": "success|error", "message": "...",

    "data": ..., "request_id": "..."}`; o endpoint de logo usa o mesmo formato
    sem

    `request_id`. Consulte o schema de cada endpoint.



    Uma requisição aceita retorna HTTP `200` com o payload de sucesso; problemas
    de

    validação retornam `400`, credenciais inválidas `401` e acesso negado `403`.

    Métodos HTTP não suportados retornam `405`, tentativas repetidas de

    autenticação falhas retornam `429` e os endpoints de carta e e-mail retornam

    `503` durante janelas de manutenção.
  contact:
    name: Suporte Escrybe
    url: https://escrybe.com.br
servers:
  - url: https://app.escrybe.com.br
    description: Produção
  - url: https://homolog.escrybe.com.br
    description: Homologação
security:
  - securityTokenQuery: []
tags:
  - name: Letters & Telegram
    description: Crie e gerencie pedidos de carta, telegrama e e-Carta (Correios).
  - name: Account & Favorites
    description: Saldo da conta, contatos salvos e logo do remetente.
  - name: Registered E-mail
    description: Envie e acompanhe e-mails registrados juridicamente.
  - name: WhatsApp Messages
    description: Envie mensagens de WhatsApp e baixe atestações com carimbo de tempo.
  - name: WhatsApp Senders
    description: Gerencie números do WhatsApp Business (remetentes).
  - name: WhatsApp Templates
    description: Crie, sincronize e gerencie modelos de mensagem do WhatsApp.
  - name: Receipts
    description: Baixe recibos legais de qualquer pedido.
paths:
  /api/v2/delete/{securityToken}/{job_id}:
    delete:
      tags:
        - Letters & Telegram
      summary: Cancelar um pedido
      operationId: cancelOrder
      parameters:
        - $ref: '#/components/parameters/SecurityTokenPath'
        - $ref: '#/components/parameters/JobIdPath'
        - name: force_update
          in: query
          schema:
            type: string
            enum:
              - 'yes'
          description: >
            Força o cancelamento, ignorando as verificações de status. Sem ele,
            apenas pedidos com status 0 (processando) ou 2 (créditos
            insuficientes) podem ser cancelados; pedidos já cancelados retornam
            400.
        - name: obs
          in: query
          schema:
            type: string
          description: 'Motivo / observação do cancelamento. Padrão: "Cancelado via API".'
      responses:
        '200':
          description: Pedido cancelado
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/V2Envelope'
                  - properties:
                      data:
                        type: object
                        properties:
                          id:
                            type: string
                          status:
                            type: integer
                            example: 5
                          status_text:
                            type: string
                            example: Cancelado
                          message:
                            type: string
        '400':
          $ref: '#/components/responses/V2BadRequest'
        '401':
          $ref: '#/components/responses/V2Unauthorized'
        '500':
          $ref: '#/components/responses/V2ServerError'
      security: []
components:
  parameters:
    SecurityTokenPath:
      name: securityToken
      in: path
      required: true
      schema:
        type: string
      description: Seu token de segurança (usado como autenticação).
    JobIdPath:
      name: job_id
      in: path
      required: true
      schema:
        type: string
      description: >-
        Visual id do pedido — dígitos para cartas/telegramas (ex.: 2607031); ids
        de e-mail registrado começam com `E` (ex.: E2607031).
  schemas:
    V2Envelope:
      type: object
      properties:
        status:
          type: integer
          example: 200
        status_message:
          type: string
        data:
          oneOf:
            - type: object
            - type: string
            - type: 'null'
  responses:
    V2BadRequest:
      description: Requisição inválida ou incompleta
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2Envelope'
          example:
            status: 400
            status_message: Requisição incompleta
            data: null
    V2Unauthorized:
      description: Token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2Envelope'
          example:
            status: 401
            status_message: Token inválido
            data: null
    V2ServerError:
      description: Erro interno
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/V2Envelope'
  securitySchemes:
    securityTokenQuery:
      type: apiKey
      in: query
      name: userSecurityToken
      description: >-
        Seu token de segurança, enviado como parâmetro `userSecurityToken`
        (query ou form).

````