Skip to main content
TypeScript

Authorizations

Authorization
string
header
required

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_id
string
required

Email address of the member to remove

Minimum string length: 1
Example:

"user@example.com"

Response

Outcome of the removal — check the success flag

success
boolean

true when the member was removed; false when no member with that email exists in the org (the response status is still 200)

Example:

true

message
string

Human-readable outcome message

Example:

"Member user@example.com deleted successfully"