inviteUsers
Invites one or more users to an account. Invitations that fail are reported in invitationErrors; invitationsSent counts those that were sent.
This page contains
Arguments
| input InviteUsersInput! PREVIEW |
InviteUsersInput fields
| account ID! | Account that will receive the invitations. |
| inviter ID | User sending the invitations. When omitted, the calling user's id is used. When the caller has no user id, no inviter is sent. |
| usesExternalIds Boolean | When true, identifiers in the invitations are external ids. Defaults to false when omitted. |
| invitations [UserInvitationInput!]! PREVIEW | Invitations to send. Each entry sends email, firstName, lastName, role, and externalIdentifier. |
Return Fields
| invitationsSent Int | Number of invitations that were sent. |
| invitationErrors [InvitationError!] PREVIEW | Errors for invitations that were not sent. |
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.