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

# Cancelar mensagens agendadas

> Cancela mensagens AGENDADAS (ainda não enviadas) pelo array de messageIds (1–100). Requer key escopada a número. Efeito real sobre a fila de envio.

**Requer uma chave com escopo de número.**



## OpenAPI

````yaml openapi.pt.json DELETE /v1/messages/cancel
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/messages/cancel:
    delete:
      tags:
        - Messages
      summary: Cancelar mensagens agendadas
      description: >-
        Cancela mensagens AGENDADAS (ainda não enviadas) pelo array de
        messageIds (1–100). Requer key escopada a número. Efeito real sobre a
        fila de envio.


        **Requer uma chave com escopo de número.**
      operationId: delete_messages_cancel
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                messageIds:
                  type: string
                  description: Ids das mensagens agendadas a cancelar.
                  example: '["msg_01HZX...", "msg_02HZX..."]'
              required:
                - messageIds
            example:
              messageIds:
                - msg_01HZX...
                - msg_02HZX...
      responses:
        '200':
          description: Cancelar agendadas
          content:
            application/json:
              example:
                cancelled: 2
                notFound: 0
        '400':
          description: Payload ou parâmetros inválidos
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Chave com escopo de tenant usada em endpoint com escopo de número
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Tenant-scoped keys cannot call number endpoints
                code: TENANT_SCOPE_NOT_ALLOWED
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````