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

# Pause a broadcast

Pauses a broadcast that is sending: one that is processing, or that is processed while its emails are still going out. An A/B test broadcast can be paused at every step of its test: while its sample is sent (testing), while it waits for its winner (test_completed) and while the winner is sent (winner_selected). Any other status is refused.

## OpenAPI

````yaml /openapi.json post /api/broadcasts.pause
openapi: 3.0.3
info:
  title: Notifuse API
  description: API for Notifuse - a transactional email and newsletter management platform
  version: 1.0.0
  contact:
    name: Notifuse Support
    url: https://www.notifuse.com/support
    email: hello@notifuse.com
  license:
    name: BUSL-1.1
    url: https://github.com/Notifuse/notifuse/blob/main/LICENSE
servers:
  - url: https://{notifuseDomain}
    description: Customer-specific Notifuse API server
    variables:
      notifuseDomain:
        description: Your unique Notifuse domain
        default: demo.notifuse.com
security: []
paths:
  /api/broadcasts.pause:
    post:
      summary: Pause a broadcast
      description: >
        Pauses a broadcast that is sending: one that is processing, or that is
        processed while its emails are still going out. An A/B test broadcast
        can be paused at every step of its test: while its sample is sent
        (testing), while it waits for its winner (test_completed) and while the
        winner is sent (winner_selected). Any other status is refused.
      operationId: pauseBroadcast
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PauseBroadcastRequest"
      responses:
        "200":
          description: Broadcast paused successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
        "400":
          description: Bad request - validation failed
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "401":
          description: Unauthorized - invalid or missing authentication token
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "404":
          description: Broadcast not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
      required:
        - error
    PauseBroadcastRequest:
      type: object
      required:
        - workspace_id
        - id
      properties:
        workspace_id:
          type: string
          description: The ID of the workspace
          example: ws_1234567890
        id:
          type: string
          description: ID of the broadcast to pause
          example: broadcast_12345
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API token for authentication
````
