curl --request PATCH \
  --url https://api.periskope.app/v1/chats/custom-properties/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-phone: <x-phone>' \
  --data '{
  "replace": true,
  "properties": {
    "1204857389897@g.us": {
      "property-bvngieuydkwbtcjn": "option1"
    }
  }
}'

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your apiKey generated in Periskope API settings.

Headers

x-phone
string
required

Organisation phone number(with country code) and without any spaces or special characters.

e.g. 9190043XXXXX

Body

application/json
replace
boolean

Adding this parameter will determine whether the existing labels will be replaced or new labels will be appended at end. Default value - true

properties
object
required

An object containing an object with property_id and value against chat_ids

For e.g. {"9190043XXXX@c.us": {"Property1": "test"}}

Was this page helpful?

List all org custom properties (Chat)Add member to group