Description

Create and send one or multiple user invitations.

Permission bit: "invitations.create"

Topic: Invitations

Arguments

data: [InvitationCreate!]!

Main argument for mutations.

shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"

Data Argument Fields

email: String!

Email of the invited user

Example: "no+spam@mail.com"

Valid when: email's length doesn't exceed 250 characters

name: String

Name of the user (used when sending an email)

Example: "Jane Smith"

Valid when: name's length doesn't exceed 250 characters

permissions: [String!]

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

role_ids: [String!]

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

Result

[Invitation!]

Preview (typescript)

Loading module