Docs
Invite Crew
POST /collaborators/{collaboratorId}/crew/invite
POST
/collaborators/{collaboratorId}/crew/inviteRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Grants access at invite time. For each member row: an email that already has a BackOps account is granted its permissions (and, if a license is supplied, an event license seat) immediately and notified; an email with no account gets a crew invitation carrying the permission payload (and an optional reserved event seat) plus a signup email. Permissions may mix Event.* and Collaborator.* strings — they are split by domain when applied. Validation is all-or-nothing: one unknown permission or an over-capacity license fails the whole request (400).
Requires Collaborator.CrewManage permission on the collaborator.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| collaboratorId | Guid | Required | The collaborator to invite/grant crew into. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| members | Member[] | Required | One row per person to invite or grant. |
| members[].crewId | Guid? | Optional | Attach the grant to an existing crew row (promote a contact); omit to create a new one. |
| members[].email | string | Required | The account email being granted access — the key the consume seam matches on. |
| members[].licenseId | Guid? | Optional | The event license to assign (existing user) or reserve (new email). Optional — crew may be added without a license. |
| members[].permissions | string[] | Optional | `Event.*` + `Collaborator.*` permission strings. Defaults to the standard crew set when omitted. |
Response
Returns 201 Created with the per-row outcomes.
| Field | Type | Description |
|---|---|---|
| results | Result[] | One entry per submitted member. |
| results[].email | string | The processed email. |
| results[].outcome | string | `granted` (existing account) or `invited` (no account yet). |
| results[].crewId | Guid | The crew row the grant/invitation was applied to. |