Retrieve WhatsApp Profile Picture

GET 
/api/v2/instance/:instanceId/chat/profile-picture

Get the profile picture of a WhatsApp registered phone number.

Request

Path Parameters

instanceId stringrequired

ID of the instance.

Query Parameters

id stringrequired

Enter the "number" or the "keyRemoteJid".

Responses

200

ProfilePicture

application/json

Schema

Schema

profileUrl string

Example (from schema)

{
  "profileUrl": "string"
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...