Skip to main content
PATCH
/
chats
/
access
Node.js
import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});

async function updateChatOverrideAccess() {
  const response = await client.chat.updateChatOverrideAccess({
    access: {
      "[email protected]": true,
      "[email protected]": false
    },
    chat_ids: [
      "[email protected]",
      "[email protected]"
    ],
    replace: false
  });

  console.log(response);
}

updateChatOverrideAccess();
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-phone
string

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Example:

"{{orgPhone}}"

Body

application/json
​
access
object
required
  • An object mapping user emails to boolean access flags
  • Note: This replaces the current override chat access property of the chats

Example: { "[email protected]": true, "[email protected]": false }

​
chat_ids
string[]
required
  • An array of chat_ids to update
​
replace
boolean
  • When true, the existing chat access overrides are fully replaced with the access map provided in this request
  • When false, the provided access values are merged into the existing overrides (only updating the specified users without removing others)

Response

204 OK

204 No Content