Update Profile Online Privacy

PATCH 
/api/v2/instance/:instanceId/whatsapp/update/profile-online-privacy

This endpoint allows you to modify the privacy settings of your "WHO CAN SEE WHEN YOU'RE ONLINE" status in WhatsApp.

Request

Path Parameters

instanceId stringrequired

ID of the instance.

application/json

Body

required

• action: A field that accepts specific values to determine who can see your "Online" status. The possible values are:
  • 'all': This allows all users to see your "Online" status.
  • 'contact_blacklist': This restricts visibility to contacts on your blocklist.
  • 'contacts': This allows only the contacts from your contact list to see your "Online" status.
  • 'none': This prevents any user from seeing your "Online" status.

action Actionrequired

Default value: all | contact_blacklist | contacts | none

Responses

200

ResponseProfileOnlinePrivacy

application/json

Schema

Schema

onlinePrivacy stringrequired
WhatsApp object
whatsappId stringrequired
remoteJid stringrequired
pictureUrl stringrequired
pushName stringrequired
createdAt stringrequired
instanceInstanceId stringrequired

Example (from schema)

{
  "onlinePrivacy": "string",
  "WhatsApp": {
    "whatsappId": "string",
    "remoteJid": "string",
    "pictureUrl": "string",
    "pushName": "string",
    "createdAt": "string",
    "instanceInstanceId": "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
}

500

InternalServerErrorException

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...