Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
profile-picture
Get contact picture
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/profile-picture \
  --header 'Client-Token: <api-key>'
{
  "link": "<string>"
}

​
Overview

This method is responsible for returning the URL with the updated contact image.
The contact image obtained via get-contacts is only available for 48 hours before WhatsApp deletes the link. To get the updated image, use this method.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Query Parameters

​
phone
string
required
Contact phone number in DDI DDD NUMBER format. E.g.: 551199999999

​
Response

​
200

​
link
string
URL with contact photo
{
  "link": "https://..."
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.