Skip to main content
POST
Get a chat's avatar

Authorizations

token
string
header
required

Body

application/json
number
string
required

Chat identifier. Accepts a number with country code, user JID, LID known to the instance, or group JID.

Minimum string length: 1
Example:

"5511999999999"

preview
boolean
default:false

true requests the preview; false requests the full image.

force
boolean
default:false

Requests an early refresh, respecting the minimum interval of 20 seconds per image and instance. Do not use for continuous polling.

Response

Picture URL, or an empty string when no image is available.

url
string
required

Temporary URL; an empty string is valid.