Preview

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

UserInvitation

An invitation for a user to join an account.

This page contains

    Fields

    email: EmailAddress

    Email address the invitation was sent to.

    inviteeEmail: String

    Email address on the invitee record, when one exists.

    role: String

    Role assigned to the invited user.

    createdOn: DateTime

    Date when the invitation was created.

    lastModified: DateTime

    Date when the invitation was last modified.

    accepted: Boolean

    Whether the invitation has been accepted.

    consumed: Boolean

    Whether the invitation has been consumed.

    inviter: User PREVIEW

    User who created the invitation. Null when the invitation has no inviter.

    account: Account PREVIEW

    Account the invitation belongs to.

    tenant: String

    Marketplace that owns the invitation.

    Parent objects of UserInvitation

    AccountInvitationsConnection PREVIEW

    Cursor-paginated list of account invitations.

    Mutations for UserInvitation

    acceptInvitation PREVIEW

    Accepts an invitation and registers the invitee. Returns the invitation after registration.