Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount or TokenInstance on every route. Each call validates instance ownership. This section covers the /api/profile/* routes for updating your own profile, looking up third-party profiles, and reading or updating WhatsApp privacy settings.

​
Endpoints

MethodPathFunction
POST/api/profile/account/:instanceUpdate picture / name / status
GET/api/profile/getAccount/:instanceGet your own or a third-party profile
GET/api/profile/getPrivacy/:instanceGet privacy settings
GET/api/profile/privacy/:instanceAlias of /getPrivacy
POST/api/profile/privacy/:instanceUpdate privacy

​
Privacy structure

The API groups settings into three sub-objects: visibility, privacy, and permissions. 
{
  "visibility": {
    "lastSeen": "contacts",
    "status": "all",
    "profile": "contacts",
    "online": "match_last_seen"
  },
  "privacy": {
    "readReceipts": "all"
  },
  "permissions": {
    "callAdd": "all",
    "groupAdd": "contacts"
  }
}

​
Accepted values per field

FieldValues
lastSeen / status / profileall / contacts / contact_blacklist / none
onlineall / match_last_seen
readReceiptsall / none
callAddall / known
groupAddall / contacts / contact_blacklist

​
AccountProfileData model

Response from GET /getAccount: 
{
  "profilePicture": "https://pps.whatsapp.net/...",
  "profileName": "João Silva",
  "profileStatus": "Disponivel",
  "phoneNumber": "5511999999999",
  "jid": "5511999999999@s.whatsapp.net",
  "lid": "199789077627112@lid"
}

​
Error envelope

{
  "success": false,
  "error": { "message": "At least one field must be provided (profilePicture, profileName, or profileStatus)" }
}

​
Error reference (summary)

CategoryMessage
ValidationAt least one field must be provided (profilePicture, profileName, or profileStatus)
ValidationAt least one privacy setting must be provided
ValidationInvalid <field> value: <value>. Valid values: ...
StateInstance is not connected to WhatsApp
NumberNumber not found or not registered on WhatsApp
Numberinvalid LID format
Failurefailed to update <field> privacy: <reason>

​
Next

Update account

Change picture, display name, or status.

Update privacy

Adjust who sees what.