TypeScript
import { PeriskopeApi } from '@periskope/periskope-client';
const client = new PeriskopeApi({
authToken: 'YOUR_API_KEY',
});
async function main() {
const response = await client.members.removeMember({
email_id: 'user@example.com',
});
console.log(response);
}
main();curl -X DELETE 'https://api.periskope.app/v1/members/user@example.com' \
-H 'Authorization: Bearer YOUR_API_KEY'{
"success": true,
"message": "Member user@example.com deleted successfully"
}{
"code": "UNAUTHORIZED_ERROR",
"message": "Invalid bearer auth token",
"status": 401
}{
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"status": 422,
"fields": {
"body.chat_id": {
"message": "chat_id is required"
}
}
}{
"code": "RATE_LIMIT_ERROR",
"message": "You can only make 100 requests per second",
"status": 429
}{
"code": "UNKNOWN_ERROR",
"message": "Internal server error",
"status": 500
}Member APIs
Delete Member
Removes a member from the org by email. Permanent — access is lost immediately.
TypeScript
import { PeriskopeApi } from '@periskope/periskope-client';
const client = new PeriskopeApi({
authToken: 'YOUR_API_KEY',
});
async function main() {
const response = await client.members.removeMember({
email_id: 'user@example.com',
});
console.log(response);
}
main();curl -X DELETE 'https://api.periskope.app/v1/members/user@example.com' \
-H 'Authorization: Bearer YOUR_API_KEY'{
"success": true,
"message": "Member user@example.com deleted successfully"
}{
"code": "UNAUTHORIZED_ERROR",
"message": "Invalid bearer auth token",
"status": 401
}{
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"status": 422,
"fields": {
"body.chat_id": {
"message": "chat_id is required"
}
}
}{
"code": "RATE_LIMIT_ERROR",
"message": "You can only make 100 requests per second",
"status": 429
}{
"code": "UNKNOWN_ERROR",
"message": "Internal server error",
"status": 500
}Authorizations
Your Periskope API token, sent as Authorization: Bearer <token>. Generate one from the Periskope dashboard under Settings → API & Webhooks. API access requires an active Pro or Enterprise plan.
Path Parameters
Email address of the member to remove
Minimum string length:
1Example:
"user@example.com"
Response
Outcome of the removal — check the success flag
Was this page helpful?