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

# Upload Media

> Upload a file to ChatSyncs to get a media_id and media_type for use with the Send File API, via multipart/form-data. Use when a developer asks how to send the same file to many recipients without re-uploading it each time.

Uploads a file and returns a `media_id`, a `media_type` and, for documents, a `media_name`, which you can reuse across multiple
[Send File](/developer-api/whatsapp/send-file) or
[Send Interactive Buttons](/developer-api/whatsapp/send-interactive-buttons) calls, instead of
hosting the file at a public URL.

<Info>
  When you send an uploaded **document**, pass all three — `media_id`, `media_type` and `media_name` —
  to [Send File](/developer-api/whatsapp/send-file).
</Info>

<Info>
  This endpoint requires `multipart/form-data` — it's POST-only, unlike most other endpoints in
  this API.
</Info>


## OpenAPI

````yaml POST /whatsapp/upload/media
openapi: 3.1.0
info:
  title: ChatSyncs Developer API
  version: 1.0.0
  description: >-
    REST API for sending WhatsApp messages and managing subscribers through
    ChatSyncs.


    **Authentication.** Send your key as the `apiToken` parameter, or as
    `Authorization: Bearer <key>` — both work on every endpoint **except Custom
    Fields List**, which only accepts the `apiToken` parameter (a Bearer header
    alone is answered with *The api token field is required.*). A wrong key
    returns HTTP 401 `{"status":"0","message":"Unauthenticated."}`; no key at
    all redirects to the login page.


    **Methods.** Every endpoint accepts both GET and POST with the same
    parameters, except Upload Media, which is POST-only. Use POST for anything
    that changes data.


    **Errors.** Failures usually come back as HTTP 200 with `"status":"0"` and
    the reason in `message`, so always check `status`. `status` is the string
    `"1"` or `"0"` on most endpoints and a boolean on a few.


    **Lists.** Endpoints that return rows put them in `message` as a list; there
    is no `data` field (Custom Fields List is the exception and uses `data`).
servers:
  - url: https://platform.chatsyncs.com/api/v1
security: []
paths:
  /whatsapp/upload/media:
    post:
      tags:
        - WhatsApp API
      summary: Upload Media
      description: >-
        Accepts `image`, `video`, `audio` and `document` files; anything else is
        answered with `This file type is not supported.` The response also
        carries `media_url` and `file`, links to where ChatSyncs stored the
        file.
      operationId: uploadMedia
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                apiToken:
                  type: string
                  description: >-
                    Your ChatSyncs API key (can also be sent as Authorization:
                    Bearer token) -- not a WhatsApp/Meta token.
                  example: API-KEY
                phone_number_id:
                  type: string
                  description: >-
                    The WhatsApp account's phone number ID. [Where to find
                    it](/developer-api/finding-ids#phone-number-id-phone_number_id).
                  example: PHONE-NUMBER-ID
                media_file:
                  type: string
                  format: binary
                  description: >-
                    The file to upload. The multipart field name must be exactly
                    media_file.
              required:
                - apiToken
                - phone_number_id
                - media_file
      responses:
        '200':
          description: >-
            Standard ChatSyncs response. `status` is `"1"` on success and `"0"`
            on failure.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: '`"1"` = success, `"0"` = failure.'
                  message:
                    type: string
                    description: Human-readable result message.
              examples:
                success:
                  summary: Success
                  value:
                    status: '1'
                    media_id: '1739230482390482'
                    media_type: document
                    media_name: invoice.pdf
                    media_url: https://example.com/livechat/invoice.pdf
                    file: https://example.com/livechat/invoice.pdf
                    message: >-
                      Upload successful. Use media_id, media_type, and
                      media_name (for documents) with the Send File API.
                error:
                  summary: A required field is missing
                  value:
                    status: '0'
                    message: >-
                      The phone number id field is required., The media file
                      field is required.
                noFile:
                  summary: Wrong multipart field name
                  value:
                    status: '0'
                    message: No file was uploaded. Use the field name media_file.
                badType:
                  summary: Unsupported file type
                  value:
                    status: '0'
                    message: This file type is not supported.
        '401':
          description: >-
            `apiToken` is wrong. (With no token at all the API redirects to the
            login page with HTTP 302 instead of returning JSON.)
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  message:
                    type: string
              examples:
                unauthenticated:
                  summary: Wrong apiToken
                  value:
                    status: '0'
                    message: Unauthenticated.

````

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