Sign in

v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
contact

get profile picture URL

Retrieves the profile picture URL for a contact, chat, group, or newsletter. Access is subject to privacy settings. Use appropriate suffixes: @c.us for contacts/chats, @g.us for groups, @newsletter for newsletters.

post/instances/{id}/client/action/get-profile-pic-url

Path parameters

idinteger required

Instance ID

Request body

contactIdstring required

ID with appropriate suffix: @c.us (contacts/chats), @g.us (groups), @newsletter (newsletters)

Example request

{
  "contactId": "123456789@c.us"
}

Response

Successfully retrieved profile picture URL

status'success' | 'error'

Example response

{
  "data": {
    "status": "success",
    "instanceId": 1,
    "data": {
      "profilePicUrl": "https://url-to-image.com/image.jpg"
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/get-profile-pic-url"
  },
  "status": "success"
}