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

# List failed broadcast messages

> Returns messages that could not be delivered due to permanent errors (e.g. invalid addresses, domain issues). Transient errors that were retried successfully do not appear here.



## OpenAPI

````yaml /openapi.json get /broadcasts/{id}/failures
openapi: 3.1.0
info:
  description: Helo API
  version: 1.0.0-beta.1
  title: Helo API
servers:
  - url: https://api.helohq.com
security: []
tags:
  - name: Activity
    description: >-
      Track and retrieve message activity, including messages, delivery and
      engagement events.
  - name: Broadcasts
    description: Manage and track broadcast email campaigns.
  - name: Channels
    description: Create and manage communication channels for organizing messages.
  - name: Domains
    description: Register, verify, and manage domains for email sending.
  - name: Sending
    description: Send transactional and broadcast emails.
  - name: Statistics
    description: Access activity statistics.
  - name: Webhooks
    description: Create and manage webhooks for event notifications.
paths:
  /broadcasts/{id}/failures:
    get:
      tags:
        - Broadcasts
      summary: List failed broadcast messages
      description: >-
        Returns messages that could not be delivered due to permanent errors
        (e.g. invalid addresses, domain issues). Transient errors that were
        retried successfully do not appear here.
      operationId: Broadcasts_listFailures
      parameters:
        - name: id
          in: path
          description: The broadcast ID.
          required: true
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          description: Results per page. Min 1, max 500.
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            format: int32
        - name: offset
          in: query
          description: Pagination offset.
          required: false
          schema:
            type: integer
            minimum: 0
            format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponseOfBroadcastFailure'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '422':
          $ref: '#/components/responses/422'
        '500':
          $ref: '#/components/responses/500'
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: ruby
          source: |-
            Helo.configure do |config|
              config.api_key = ENV.fetch("HELO_API_KEY")
            end

            id = "550e8400-e29b-41d4-a716-446655440000"
            opts = {
              limit: 10,
              offset: 10
            }
            Helo::Broadcasts.list_failures(id, opts)
        - lang: javascript
          source: |-
            import Helo from "@helo-email/sdk";

            const apiKey = process.env.HELO_API_KEY;
            const helo = new Helo(apiKey);

            const result = await helo.broadcasts.listFailures(
              "550e8400-e29b-41d4-a716-446655440000",
              {
                limit: 10,
                offset: 10,
              },
            );
        - lang: go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"log\"\n\t\"os\"\n\n\t\"github.com/helo-email/helo-sdk-go\"\n)\n\nfunc main() {\n\tclient := helo.NewHelo(os.Getenv(\"HELO_API_KEY\"))\n\tctx := context.Background()\n\n\tparams := &helo.BroadcastsListFailuresParams{\n\t\tLimit: 10,\n\t\tOffset: 10,\n\t}\n\tresult, err := client.Broadcasts.ListFailures(ctx, \"550e8400-e29b-41d4-a716-446655440000\", params)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\t_ = result\n}"
        - lang: csharp
          source: var failures = await helo.Broadcasts.ListFailures("broadcast-id");
        - lang: python
          source: |-
            import sdk_helo_email as helo

            client = helo.Helo()  # reads HELO_API_KEY from the environment

            failures = client.broadcasts.list_failures("broadcast-id")
components:
  schemas:
    PaginatedResponseOfBroadcastFailure:
      type: object
      properties:
        totalCount:
          type: integer
          format: int32
        results:
          type: array
          items:
            $ref: '#/components/schemas/BroadcastFailureResponse'
      required:
        - totalCount
        - results
    BroadcastFailureResponse:
      type: object
      properties:
        recipients:
          $ref: '#/components/schemas/RecipientHeaders'
        messageIndex:
          type: integer
          format: int32
          description: >-
            Zero-based index of the failed message within the original
            `messages` array.
        errorCode:
          type: string
          description: >-
            Machine-readable error code (e.g. `invalid_recipient`,
            `domain_unverified`).
        errorMessage:
          type: string
          description: Human-readable description of the failure.
      required:
        - recipients
        - messageIndex
        - errorCode
        - errorMessage
    ErrorResponse:
      description: Standard error response body.
      type: object
      properties:
        type:
          description: A URI reference identifying the problem type.
          type: string
        title:
          description: Short, human-readable summary of the problem.
          type: string
        instance:
          description: URI reference identifying the specific occurrence of the problem.
          type: string
        status:
          description: HTTP status code.
          type: integer
          format: int32
        code:
          description: Application-specific error code.
          type: string
        detail:
          description: Human-readable explanation of this specific occurrence.
          type: string
        requestId:
          description: Unique request ID, useful for support correlation.
          type: string
        errors:
          description: Field-level validation errors, keyed by field name.
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ValidationError'
    RecipientHeaders:
      type: object
      properties:
        to:
          type: array
          items:
            $ref: '#/components/schemas/MailAddress'
        cc:
          type: array
          items:
            $ref: '#/components/schemas/MailAddress'
        bcc:
          type: array
          items:
            $ref: '#/components/schemas/MailAddress'
      required:
        - to
    ValidationError:
      description: A single field validation error.
      required:
        - message
      type: object
      properties:
        message:
          description: Description of the validation failure.
          type: string
    MailAddress:
      type: object
      properties:
        email:
          type: string
          description: Email address. Max 254 characters.
        name:
          type: string
          description: Display name shown to recipients in their email client.
      required:
        - email
  responses:
    '401':
      description: Unauthorized
    '403':
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '404':
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '422':
      description: Unprocessable Entity
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '500':
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````