POST/crew/invite
Gives one or more people access to the organization, each with an org license and a list of Organization permissions. An email that already has a BackOps account
is added at once (outcome granted, no email sent); a new email gets an invitation email, a pending invitation and a reserved seat (outcome invited).
Set crewId (from Crew_GetCrew or Crew_LookupCrew) to attach access to an existing record, or omit it to create one from the contact fields, typeIds and attribute values; licenseId comes from the Billing API's Licenses_GetLicenses. Needs Organization admin.
Request Body
| Field | Type | Required | Description |
|---|
| members | InviteCrewRequestMember[] | Optional | |
InviteCrewRequestMember
| Field | Type | Description |
|---|
| crewId | uuid| null | |
| connectedUserEmail | string| null | |
| email | string| null | |
| firstName | string| null | |
| lastName | string| null | |
| phoneNumber | string| null | |
| licenseId | uuid | |
| permissions | string[]| null | |
| typeIds | uuid[]| null | |
| attributeValues | InviteCrewRequestAttributeValueInput[]| null | |
| Field | Type | Description |
|---|
| attributeId | uuid | |
| value | string| null | |
Response
| Field | Type | Description |
|---|
| results | InviteCrewResponseResult[]| null | |
InviteCrewResponseResult
| Field | Type | Description |
|---|
| email | string| null | |
| outcome | string| null | |
| crewId | uuid | |