Preview

InviteUsersInput is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

InviteUsersInput

Input for inviting users to an account.

This page contains

    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.

    Mutations for InviteUsersInput

    inviteUsers PREVIEW

    Invites one or more users to an account. Invitations that fail are reported in invitationErrors; invitationsSent counts those that were sent.