Sessions

Revoke a session share

Revoke a read-only share by email. Removes either an active share (for a registered recipient) or a pending invitation. Only the session owner can revoke shares.

The operation is idempotent: revoking an email that isn't currently shared returns revoked: false with 200 OK.

Example

curl -X DELETE https://elicit.com/api/v2/sessions/{sessionId}/shares \
  -H "Authorization: Bearer elk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"email":"colleague@example.com"}'

delete/sessions/{sessionId}/shares

Path parameters

sessionIdstring uuid required

The session ID (UUID) returned by the create endpoints and GET /sessions

Example:5ad08bfb-cbe0-4911-a8c3-309760d33029

The session ID (UUID) returned by the create endpoints and GET /sessions

Request body

emailstring email required

Email address whose share (or pending invite) should be revoked.

Example request

{
  "email": "colleague@example.com"
}

Response

The share was revoked, or there was nothing to revoke (idempotent).

sessionIdstring required

Unique identifier for the session.

emailstring required

Email address whose share was revoked.

revokedboolean required

Whether an existing share or pending invite was removed. False when there was nothing to revoke (the call is idempotent either way).

Changes

No recorded changes to this endpoint across all 1 revision of this API.