Skip to main content
POST
/
status
/
image
curl --request POST \
  --url https://wsapi.chat/status/image \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>' \
  --data '
{
  "url": "https://example.com/photo.jpg",
  "mimeType": "image/jpeg",
  "caption": "Beautiful sunset"
}
'
{
  "id": "01234567890123456"
}

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Body

application/json
​
data
string

Base64-encoded media data (mutually exclusive with url)

​
url
string<uri>

URL to download the media from (mutually exclusive with data, max 50 MB)

​
mimeType
string

MIME type of the media

​
caption
string

Media caption

Response

Resource created

​
id
string

ID of the created resource