Docs
Create Share
POST /documents/{documentId}/shares
POST
/documents/{documentId}/sharesRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder. |
Grants a Collaborator or Crew member access to a document. Requires Admin access on the document (i.e. the EventDocumentsEdit permission).
Exactly one of collaboratorId or crewId must be provided. Sharing with a Collaborator grants access to all of their Crew members (fan-out).
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| collaboratorId | uuid | Optional | Collaborator to share with. Mutually exclusive with `crewId`. |
| crewId | uuid | Optional | Crew member to share with directly. Mutually exclusive with `collaboratorId`. |
| permissions | string[] | Required | Access level(s) to grant. One or more of: `Read`, `Write`, `Admin`. |
Response
201 Created with no body.