Skip to main content
POST
Invite members
Requires an OAuth bearer token and Admin or Owner permission for every target group. Send recipient emails and targets containing organization_id and role. This sends invitation emails. Inspect both created and skipped in the response; one successful HTTP response does not mean every recipient received a new invitation. Empty/invalid targets or roles return 400; insufficient target access returns 403. API keys are not accepted.

Authorizations

Authorization
string
header
required

Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.

Body

application/json
emails
string<email>[]
required
targets
InviteTarget · object[]
required

Response

Successful Response

created
InviteResponse · object[]
required
skipped
SkippedInvite · object[]
required