Mutation
mutation InviteUserToWorkspace($input: InviteUserToWorkspaceInput!) {
inviteUserToWorkspace(input: $input) {
invite {
id
createdBy {
__typename
... on UserActor {
__typename
}
}
createdAt {
unixTimestamp
iso8601
}
email
workspace {
id
name
publicName
isDemoWorkspace
domainName
domainNames
}
isAccepted
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"email": "string"
}
}Response
{
"data": {
"inviteUserToWorkspace": {
"invite": {
"id": "id",
"createdBy": {
"__typename": "UserActor"
},
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"email": "string",
"workspace": {
"id": "id",
"name": "string",
"publicName": "string",
"isDemoWorkspace": true,
"domainName": "string",
"domainNames": [
"string"
]
},
"isAccepted": true
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
inviteUserToWorkspace
Send a workspace invitation to a user by email. Specify either a built-in roleKey (e.g. SUPPORT, ADMIN) or a customRoleId to control the permissions they receive on joining. Sends an invitation email to the provided address.
MUTATION
inviteUserToWorkspace(input: InviteUserToWorkspaceInput!): InviteUserToWorkspaceOutput!Arguments
input
required
Returns
invite
error
Mutation
mutation InviteUserToWorkspace($input: InviteUserToWorkspaceInput!) {
inviteUserToWorkspace(input: $input) {
invite {
id
createdBy {
__typename
... on UserActor {
__typename
}
}
createdAt {
unixTimestamp
iso8601
}
email
workspace {
id
name
publicName
isDemoWorkspace
domainName
domainNames
}
isAccepted
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"email": "string"
}
}Response
{
"data": {
"inviteUserToWorkspace": {
"invite": {
"id": "id",
"createdBy": {
"__typename": "UserActor"
},
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"email": "string",
"workspace": {
"id": "id",
"name": "string",
"publicName": "string",
"isDemoWorkspace": true,
"domainName": "string",
"domainNames": [
"string"
]
},
"isAccepted": true
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?

