Skip to main content

Invite

An invitation sent to join a Holaplex organization.

type Invite {
  id: UUID!
  email: String!
  status: InviteStatus!
  organizationId: UUID!
  createdBy: UUID!
  createdAt: DateTime!
  updatedAt: DateTime
  member: Member
  organization: Organization
}

Fields​

Invite.id ● UUID! non-null scalar​

The ID of the invitation.

Invite.email ● String! non-null scalar​

The email address of the user being invited to become a member of the organization.

Invite.status ● InviteStatus! non-null enum​

The status of the invitation.

Invite.organizationId ● UUID! non-null scalar​

The ID of the organization to which the invitation belongs.

Invite.createdBy ● UUID! non-null scalar​

The ID of the user who created the invitation.

Invite.createdAt ● DateTime! non-null scalar​

The datetime, in UTC, when the invitation to join the organization was created.

Invite.updatedAt ● DateTime scalar​

The datetime, in UTC, when the invitation status was updated.

Invite.member ● Member object​

The member record that is generated after the invitation to join the organization is accepted. When the user has not accepted the invitation, this field returns null.

Invite.organization ● Organization object​

The organization to which the invitation to join belongs.

Returned by​

invite query ● inviteMember mutation

Member of​

AcceptInvitePayload object ● Member object ● Organization object