Mutation
mutation CreateTenant($input: CreateTenantInput!) {
createTenant(input: $input) {
tenant {
id
name
externalId
url
source
tier {
id
name
externalId
color
isDefault
defaultPriority
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"name": "string",
"externalId": "string"
}
}Response
{
"data": {
"createTenant": {
"tenant": {
"id": "id",
"name": "string",
"externalId": "string",
"url": "string",
"source": "API",
"tier": {
"id": "id",
"name": "string",
"externalId": "string",
"color": "string",
"isDefault": true,
"defaultPriority": 1
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
createTenant
Creates a new tenant. Fails with a validation error if a tenant already exists with the provided externalId.
Use upsertTenant instead if you want to create or update a tenant idempotently.
Requires the tenant:create permission.
MUTATION
createTenant(input: CreateTenantInput!): CreateTenantOutput!Arguments
input
required
Returns
tenant
error
Mutation
mutation CreateTenant($input: CreateTenantInput!) {
createTenant(input: $input) {
tenant {
id
name
externalId
url
source
tier {
id
name
externalId
color
isDefault
defaultPriority
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"name": "string",
"externalId": "string"
}
}Response
{
"data": {
"createTenant": {
"tenant": {
"id": "id",
"name": "string",
"externalId": "string",
"url": "string",
"source": "API",
"tier": {
"id": "id",
"name": "string",
"externalId": "string",
"color": "string",
"isDefault": true,
"defaultPriority": 1
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?

