Gallery Platform API
Reference

Revoke a legal document share link

Disables a public click-to-accept link. Idempotent. A recorded acceptance is unaffected; the link simply stops resolving.

POST
/gallery/legal-documents/{id}/shares/{shareId}/revoke

Disables a public click-to-accept link. Idempotent. A recorded acceptance is unaffected; the link simply stops resolving.

Authorization

bearerAuth legal_documents:update
AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: legal_documents:update

Path Parameters

id*string
shareId*string

Header Parameters

Idempotency-Key?string

Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "id": "string",  "document_id": "string",  "recipient_name": "string",  "recipient_email": "string",  "expires_at": "string",  "revoked_at": "string",  "has_passcode": true,  "sent_at": "string",  "first_viewed_at": "string",  "last_viewed_at": "string",  "view_count": -9007199254740991,  "accepted_at": "string",  "accepted_name": "string",  "accepted_pdf_sha256": "string",  "created_at": "string"}