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

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/get-profile-pic-url
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

contactIdstring required

ID with its suffix: @c.us or @lid (contacts), @g.us (groups), @newsletter (channels).

Example request

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

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Successfully retrieved profile picture URL.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "data": {
    "status": "success",
    "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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.