Mutation
mutation UpsertTenant($input: UpsertTenantInput!) {
upsertTenant(input: $input) {
tenant {
id
name
externalId
url
source
tier {
id
name
externalId
color
isDefault
defaultPriority
}
}
result
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"identifier": {},
"name": "string",
"externalId": "string"
}
}Response
{
"data": {
"upsertTenant": {
"tenant": {
"id": "id",
"name": "string",
"externalId": "string",
"url": "string",
"source": "API",
"tier": {
"id": "id",
"name": "string",
"externalId": "string",
"color": "string",
"isDefault": true,
"defaultPriority": 1
}
},
"result": "UPDATED",
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
upsertTenant
Creates a new tenant or updates an existing one identified by externalId or tenantId.
Use this to keep Plain’s tenant records in sync with the groups or organisations in your own product.
The result field on the output indicates whether a record was created or updated.
Requires the tenant:read and tenant:create permissions.
MUTATION
upsertTenant(input: UpsertTenantInput!): UpsertTenantOutput!Arguments
input
required
Returns
tenant
result
error
Mutation
mutation UpsertTenant($input: UpsertTenantInput!) {
upsertTenant(input: $input) {
tenant {
id
name
externalId
url
source
tier {
id
name
externalId
color
isDefault
defaultPriority
}
}
result
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"identifier": {},
"name": "string",
"externalId": "string"
}
}Response
{
"data": {
"upsertTenant": {
"tenant": {
"id": "id",
"name": "string",
"externalId": "string",
"url": "string",
"source": "API",
"tier": {
"id": "id",
"name": "string",
"externalId": "string",
"color": "string",
"isDefault": true,
"defaultPriority": 1
}
},
"result": "UPDATED",
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?

