OrganizationInvitationCreate

Description

Topic: Invitations

Fields

admin_entity_id: String

Entity ID the user is invited to

Example: "en_EQzGqWoY"

Valid when: admin_entity_id matches regexp pattern: ^en_

admin_organization: Boolean

Whether user is an admin of organization

Example: true

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

shop_id: String

Shop ID the user is invited to

Example: "sh_EQzGqWoY"

Valid when: shop_id matches regexp pattern: ^sh_

Used By

Mutations

organizationsInvitationsCreate

Preview (typescript)

Loading module