Skip to main content
POST
Invite team members

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Body

application/json

Invite team members by email and/or copy existing members into the token tenant's company. The company is always the token's company (any companyId in the body is ignored).

copyMembers
string[]

User IDs of existing users to copy as members (only agencies may copy members).

emailInvites
object[]

Email invitations to send.

propagateToAgency
boolean

Propagate members to all agency companies.

subaccountOnly
boolean

Restrict added access to this subaccount only.

Response

Invitation results: counts copied/invited, any failed email invites, and skipped student/creator accounts.

data
object
required

Result of an invite-team operation.