Gallery Platform API
Reference

Delete an offer document

Deletes a document row and removes its backing object from Storage. Requires a first-party session.

DELETE
/gallery/offers/{id}/documents/{documentId}

Deletes a document row and removes its backing object from Storage. Requires a first-party session.

Authorization

bearerAuth offers:delete
AuthorizationBearer <token>

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

In: header

Scope: offers:delete

Path Parameters

id*string

The offer id.

documentId*string

The document id.

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",  "deleted": true}

Register an offer document POST

Registers an already-uploaded object (from the upload-url endpoint) as a document row, appended to the end. Requires a first-party session.

List offer documents GET

Lists the collateral attached to an offer (tearsheet, price list, press release). Every recipient's send encloses this set. A first-party session gets a short-lived signed download URL for each; an API-key principal has no membership, so it reads none.