Docs
Join Event
POST /Events/{eventId}/join
POST
/Events/{eventId}/joinRequired 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, or call `GET /Events/{eventId}/authorize` manually. |
⚠️ Internal use only. This endpoint is intended for organization members joining an event through the BackOps application UI. External API consumers should instead use the Assign License / Unassign License endpoints to add and manage users on an event.
Adds the authenticated user to an event under a specified collaborator. The caller can choose to join as a licensed user (gaining EventAdmin access) or as a guest (gaining EventBasicAccess only).
If joining as licensed, the user must either:
- Belong to an organization with the
OrgProfeature flag (no individual license seat required), or - Provide a specific
licenseIdto consume an available license seat.
This call is idempotent — if the user is already on the event, it returns 200 OK without making changes.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| eventId | Guid | Required | The ID of the event to join. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| collaboratorId | Guid | Required | The collaborator to join under. Must belong to this event. |
| joinLicensed | bool | Required | If `true`, join with full `EventAdmin` access (consumes a license if required). If `false`, join as a guest with `EventBasicAccess` only. |
| licenseId | Guid? | Optional | The ID of the license seat to assign. Required when `joinLicensed` is `true` and the organization does not have the `OrgPro` feature flag. |
Example Request (licensed, with license seat)
{
"collaboratorId": "0197f069-bd91-76c8-bfd0-5e287b932da7",
"joinLicensed": true,
"licenseId": "lic-guid-0001"
}
Example Request (guest / basic access)
{
"collaboratorId": "0197f069-bd91-76c8-bfd0-5e287b932da7",
"joinLicensed": false,
"licenseId": null
}
Response
200 OK — No response body.
Error Codes
| Code | HTTP Status | Description |
|---|---|---|
UNAUTHORIZED | 401 | Missing or invalid token, or caller is not an org admin. |
NOT_FOUND | 404 | Event not found in the caller's organization. |
BAD_REQUEST | 400 | Collaborator does not belong to this event, or licenseId was not provided when required. |