Types > OrganizationInvitation
Commerce APITypesOrganizationInvitation

OrganizationInvitation

Description

Topic: Invitations

Fields

admin_entity_id: String

Entity ID the user is invited to

Example: "en_EQzGqWoY"


admin_organization: Boolean

Whether user is an admin of organization

Example: true


created_at: String!

The date and time when the user invitation was created, RFC 3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


email: String!

Email of the invited user

Example: "no+spam@mail.com"


email_sent_at: String

The date and time when the user invitation email was sent, RFC 3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)


id: String!

Unique identifier for a user invitation

Example: "in_EQzGqWoY"


name: String!

Name of the user (used when sending an email)

Example: "Jane Smith"


permissions: [String!]

A set of permission bits to set for a user when he accepts an invite


roles: [Role]

A set of roles to set for a user when he accepts an invite

Expandable


shop_id: String

Shop ID the user is invited to

Example: "sh_EQzGqWoY"


Used By

Mutations

organizationsInvitationsAccept, organizationsInvitationsCreate

Queries

organizationsInvitations

Preview (typescript)

Loading module