Skip to main content
POST
Add media item by URL
Required scope: whatsapp.edit

Authorizations

Authorization
string
header
required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id
string<uuid>
required

Collection ID

Body

application/json
url
string<uri>
required
Maximum string length: 2000
kind
enum<string>
required
Available options:
IMAGE,
DOCUMENT,
VIDEO,
AUDIO
caption
string
Maximum string length: 500
fileName
string
Maximum string length: 200

Response

Created item.

id
string
required
kind
enum<string>
required
Available options:
TEXT,
IMAGE,
DOCUMENT,
VIDEO,
AUDIO
fileName
string | null
required
mimeType
string | null
required
sizeBytes
number | null
required
caption
string | null
required
isUploaded
boolean
required
url
string | null
required
sortOrder
number
required
createdAt
string
required