Skip to main content
DELETE
/
members
/
{id}
Node.js
import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
});

async function deleteMember() {
  const response = await client.members.delete({
    id: '[email protected]'
  });

  console.log(response);
}

deleteMember();
{
  "success": true,
  "message": "Member [email protected] deleted successfully"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<email>
required

Email address of the member to delete

Example:

"[email protected]"

Response

200 - application/json

200 OK

​
success
boolean

Whether the member was deleted successfully

Example:

true

​
message
string

Email address of the member to delete

Example:

"Member [email protected] deleted successfully"