> ## 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.

# Cancel scheduled messages

> Cancels SCHEDULED (not yet sent) messages by an array of messageIds (1–100). Requires a number-scoped key. Real side effect on the send queue.

**Requires a number-scoped key.**



## OpenAPI

````yaml openapi.json DELETE /v1/messages/cancel
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `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: Cancel scheduled messages
      description: >-
        Cancels SCHEDULED (not yet sent) messages by an array of messageIds
        (1–100). Requires a number-scoped key. Real side effect on the send
        queue.


        **Requires a number-scoped key.**
      operationId: delete_messages_cancel
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                messageIds:
                  type: string
                  description: Ids of scheduled messages to cancel.
                  example: '["msg_01HZX...", "msg_02HZX..."]'
              required:
                - messageIds
            example:
              messageIds:
                - msg_01HZX...
                - msg_02HZX...
      responses:
        '200':
          description: Cancel scheduled
          content:
            application/json:
              example:
                cancelled: 2
                notFound: 0
        '400':
          description: Invalid payload or parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Missing or invalid `x-api-key` / `x-api-key-id` header
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Tenant-scoped key used on a number-scoped endpoint
          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: Rate limit exceeded
          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: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````