Invite an artist to claim a studio account
Creates a pending invitation anchored to an artist record and emails the artist a claim link. One pending invitation per artist. Requires an Idempotency-Key header (the email is an irreversible side effect): a retry with the same key replays the original result for 24h instead of emailing again.
Creates a pending invitation anchored to an artist record and emails the artist a claim link. One pending invitation per artist. Requires an Idempotency-Key header (the email is an irreversible side effect): a retry with the same key replays the original result for 24h instead of emailing again.
Authorization
bearerAuth artists:writeA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: artists:write
Header Parameters
Required — this write has an irreversible side effect. Send a unique key per logical operation; a retry with the same key replays the original success for 14 days instead of re-running it. Reusing a key with a different body returns 400. Omitting the header returns 400.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Invite an artist (by email) to claim a free studio account, anchored to their artist record.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "id": "string", "artist_id": "string", "email": "string", "status": "pending", "share_profile": true, "expires_at": "string", "created_at": "string"}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}Update an artist connection PATCH
Updates the connection's D9 disclosure flags or status (pause/resume/disconnect). A disconnected connection cannot be reactivated — the artist must claim a fresh invitation.
Revoke an artist invitation DELETE
Revokes a pending artist invitation (soft: flips its status to revoked, freeing the artist for a re-invite). The claim link stops working immediately.