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

# Upload template header media

> Upload the header attachment (image, document or video) for a media-header template. Send the file as `file`; optional `fileName` sets the display name.

**Required scope:** `whatsapp.edit`


## OpenAPI

````yaml /api-reference/openapi.json post /whatsapp/templates/{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/templates/{id}/media:
    post:
      summary: Upload template header media
      description: >-
        Upload the header attachment (image, document or video) for a
        media-header template. Send the file as `file`; optional `fileName` sets
        the display name.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Template ID
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                fileName:
                  type: string
              required:
                - file
      responses:
        '200':
          description: Attachment stored.
          content:
            application/json:
              schema:
                type: object
                properties:
                  headerKind:
                    type: string
                  mediaUrl:
                    type: string
                    nullable: true
                  reviewReady:
                    type: boolean
                  reviewIssue:
                    type: string
                    nullable: true
                required:
                  - headerKind
                  - mediaUrl
                  - reviewReady
                  - reviewIssue
        '400':
          description: |-
            - `invalid_request`: The input was rejected.
            - `no_file`: No file uploaded for template media.
        '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.
        '403':
          description: >-
            - `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: >-
            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '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.
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.