Sessions

Revoke a session share

Changed on

Revoke a direct session share or pending invitation by email, regardless of permission level. Only the session owner can revoke shares.

Warning: this endpoint revokes readers, editors, and reviewers. It is not limited to the read-only entries returned by GET on this path: an editor or reviewer omitted from that list still loses their direct share when their email is deleted. Inspect higher-permission collaborators in the web interface before revoking access.

The operation is idempotent: when the email has no direct share or pending invitation, it returns revoked: false with 200 OK. Absence from the read-only share list alone does not imply there is nothing to revoke.

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

Request

  • Base URL
    https://elicit.com/api/v2
  • URL
    https://elicit.com/api/v2/sessions/{sessionId}/shares
  • Auth
    HTTP bearer

Path parameters

sessionIdstring uuid required

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

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

Request body

emailstring email required

Email address whose direct share or pending invite should be revoked, at any role. This can remove editor/reviewer permissions even when the email is absent from the read-only share list.

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 direct share or pending invite was removed, regardless of role (reader, editor, or reviewer). False when nothing was removed; absence from the read-only share list does not imply false. Repeating the call is idempotent.

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status