Types > Invitation
Commerce APITypesInvitation
Invitation

Description

Topic: Invitations

Fields

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

Permission bit: "roles.read"


Used By

Mutations

invitationsAccept, invitationsCreate

Queries

invitations

Preview (typescript)

Loading module