Docs
Create Link
POST /documents/{documentId}/links
POST
/documents/{documentId}/linksRequired 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. |
Creates a public access link for a document. The link contains a cryptographically random URL-safe token that can be shared with anyone — including people without BackOps accounts.
Links are active by default. Use Update Link to deactivate, set an expiry, or pre-set variable values and allowed value constraints.
Requires Admin access on the document (i.e. the EventDocumentsEdit permission or an Admin share).
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| documentId | Guid | Optional | The document to create a link for. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Required | A human-readable label for this link (e.g. "Crew Share", "Sponsor View"). |
Response
201 Created with no body.