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
custom_properties
object
required

An object containing all the property IDs and values you want to update. Note: Only properties with text values can be updated with this API. Other property types like dropdown, date, etc., if provided, will result in failure.

e.g. { "property_id": "property_value" }

You can find the property IDs using the List all org custom properties (Chat) API

chat_ids
string[]
required

Array of Chat IDs that contain the property you want to update.

e.g. ["9190043XXXXX@c.us", "120364434XXXXXX@g.us"]