mutation CreateInvites($input: CreateInvitesInput!) {
createInvites(input: $input) {
clientMutationId
count
errors
ignoredRecipients
invites {
channel
convertedAt
createdAt
expiresAt
id
message
}
mode
}
}{
"input": {}
}{
"data": {
"createInvites": {
"clientMutationId": "string",
"count": 1,
"errors": [
"string"
],
"ignoredRecipients": [
"string"
],
"invites": [
{
"channel": "string",
"convertedAt": "value",
"createdAt": "value",
"expiresAt": "value",
"id": "id",
"message": "string"
}
],
"mode": "string"
}
}
}createInvites
Invite people to a Space, the Network, or a Payment Plan by email or by
existing member. On the public API, attributing the invite to another member
or inviting as host or moderator additionally requires the
host:write:network_members OAuth scope, and a Promo Code or waived Plan
gates requires host:write:network_plans.
Required scopes: write:invites, host:write:network_members (any one)
createInvites(input: CreateInvitesInput!): CreateInvitesPayloadArguments
Parameters for CreateInvites
Returns
A unique identifier for the client performing the mutation.
Number of recipients accepted for invite creation.
Recipients skipped because they are already members or already have a pending invite, as email addresses or member names.
The invites created by this request, each carrying the url to share. Populated only when deliver is false; a delivered batch creates its rows in the background, where Network.invites reads them.
How the invites were created: 'sync' when created immediately, 'async' when enqueued for background delivery. Null when the request was rejected.
mutation CreateInvites($input: CreateInvitesInput!) {
createInvites(input: $input) {
clientMutationId
count
errors
ignoredRecipients
invites {
channel
convertedAt
createdAt
expiresAt
id
message
}
mode
}
}{
"input": {}
}{
"data": {
"createInvites": {
"clientMutationId": "string",
"count": 1,
"errors": [
"string"
],
"ignoredRecipients": [
"string"
],
"invites": [
{
"channel": "string",
"convertedAt": "value",
"createdAt": "value",
"expiresAt": "value",
"id": "id",
"message": "string"
}
],
"mode": "string"
}
}
}