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

# Reply on a WhatsApp thread with an attachment

**Required scope:** `whatsapp.send`

**Idempotency:** an `Idempotency-Key` header is required when calling with an API key. See [Idempotency](/concepts/idempotency).


## OpenAPI

````yaml /api-reference/openapi.json post /whatsapp/conversations/{id}/media
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /whatsapp/conversations/{id}/media:
    post:
      summary: Reply on a WhatsApp thread with an attachment
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          description: >-
            Unique value (e.g. a UUID) per action, up to 200 printable ASCII
            characters. Reuse it only to retry the same request; the first
            response is replayed for 24 hours.
          schema:
            type: string
            maxLength: 200
            example: f1d2c3b4-0000-4000-8000-000000000000
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                caption:
                  type: string
              required:
                - file
      responses:
        '202':
          description: Queued
          content:
            application/json:
              schema:
                type: object
                properties:
                  messages:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        direction:
                          type: string
                          enum:
                            - OUTBOUND
                            - INBOUND
                        toPhone:
                          type: string
                        type:
                          type: string
                          enum:
                            - TEXT
                            - IMAGE
                            - DOCUMENT
                            - VIDEO
                            - AUDIO
                        body:
                          type: string
                          nullable: true
                        status:
                          type: string
                          enum:
                            - QUEUED
                            - SENT
                            - DELIVERED
                            - READ
                            - FAILED
                        providerMsgId:
                          type: string
                          nullable: true
                        mediaItemId:
                          type: string
                          nullable: true
                        collectionId:
                          type: string
                          nullable: true
                        callId:
                          type: string
                          nullable: true
                        campaignId:
                          type: string
                          nullable: true
                        error:
                          type: string
                          nullable: true
                        createdAt:
                          type: string
                        sentAt:
                          type: string
                          nullable: true
                        deliveredAt:
                          type: string
                          nullable: true
                        readAt:
                          type: string
                          nullable: true
                        templateId:
                          type: string
                          nullable: true
                        providerErrorReason:
                          type: string
                          nullable: true
                        failureReason:
                          type: string
                          nullable: true
                        templateValues:
                          type: object
                          nullable: true
                          properties:
                            headerValues:
                              type: array
                              items:
                                type: string
                            bodyValues:
                              type: array
                              items:
                                type: string
                            name:
                              type: string
                            templatePurpose:
                              type: string
                            fileName:
                              type: string
                        conversationId:
                          type: string
                          nullable: true
                        contactId:
                          type: string
                          nullable: true
                        campaignContactId:
                          type: string
                          nullable: true
                        hasMedia:
                          type: boolean
                        mediaMimeType:
                          type: string
                          nullable: true
                        mediaFileName:
                          type: string
                          nullable: true
                      required:
                        - id
                        - direction
                        - toPhone
                        - type
                        - body
                        - status
                        - providerMsgId
                        - mediaItemId
                        - collectionId
                        - callId
                        - campaignId
                        - error
                        - createdAt
                        - sentAt
                        - deliveredAt
                        - readAt
                        - templateId
                        - providerErrorReason
                        - failureReason
                        - templateValues
                        - conversationId
                        - contactId
                        - campaignContactId
                        - hasMedia
                        - mediaMimeType
                        - mediaFileName
                required:
                  - messages
        '400':
          description: >-
            - `file_required`: Multipart request had no file.

            - `idempotency_key_invalid`: Idempotency-Key is over 200 chars or
            has non-printable or non-ASCII characters.

            - `idempotency_key_required`: A billed endpoint was called without
            an `Idempotency-Key` header (`400`), or a `/v1` lead push without
            `idempotencyKey` in the body (`422`).

            - `invalid_phone`: Phone number could not be normalised.

            - `invalid_request`: The input was rejected.

            - `media_too_large`: Media exceeds the per-kind limit.

            - `no_sender_available`: No usable WhatsApp sender for the
            workspace.

            - `unsupported_media_type`: Media type not sendable.

            - `window_closed`: 24h customer-service window closed.
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '402':
          description: >-
            - `provider_wallet_empty`: The WhatsApp messaging account has no
            balance.
        '403':
          description: >-
            - `account_restricted`: The WhatsApp messaging account is
            restricted.

            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `conversation_not_found`: Conversation not found.

            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '409':
          description: >-
            - `idempotency_in_progress`: A request with the same Idempotency-Key
            is still running.
        '422':
          description: >-
            - `idempotency_key_reused`: The `Idempotency-Key` was already used
            for a different request (`422`). On `POST /calls/test`, `409` means
            a call with this key already exists.
        '429':
          description: |-
            - `rate_limited`: Too many requests.
            - `send_cap_reached`: Daily WhatsApp send cap reached.
        '500':
          description: >-
            - `LIMIT_FILE_SIZE`: The uploaded file is larger than the endpoint
            allows. Currently returned as `500`.

            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
        '502':
          description: >-
            - `upstream_unavailable`: A connected service (messaging or speech)
            is unavailable.
        '503':
          description: >-
            - `idempotency_unavailable`: The idempotency check could not run.
            Nothing was done.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.