Skip to main content
POST
whatsapp.media.upload

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
accountId
string

The sending account, from social.accounts.list. Optional when only one is connected.

Required string length: 1 - 256
fileId
string

Id of an uploaded file holding WhatsApp media, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
url
string

Public media link, copied into owned storage before uploading.

mimeType
string

Media type matching the uploaded file.

Required string length: 1 - 128

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.