Preview

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

InvitationError

A failure for one invitation in a bulk invite.

This page contains

    Fields

    index: Int

    Position of the failed invitation in the submitted list.

    type: InvitationErrorType PREVIEW

    Why the invitation failed.

    email: EmailAddress

    Email address of the failed invitation.

    externalIdentifier: String

    External identifier of the failed invitation, when one was submitted.

    role: String

    Role submitted for the failed invitation.

    Mutations for InvitationError

    inviteUsers PREVIEW

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