Mutation
mutation ImportTenants($input: ImportTenantsInput!) {
importTenants(input: $input) {
result {
added
updated
skipped
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"tenants": [
{
"externalId": "string",
"name": "string"
}
]
}
}Response
{
"data": {
"importTenants": {
"result": {
"added": 1,
"updated": 1,
"skipped": 1
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
importTenants
Upsert up to 25 tenants from an external system using their externalId for idempotency. Optionally include tenant field values to sync custom fields alongside the tenant record. Returns an ImportResult with added, updated, and skipped counts.
MUTATION
importTenants(input: ImportTenantsInput!): ImportTenantsOutput!Arguments
input
required
Returns
result
error
Mutation
mutation ImportTenants($input: ImportTenantsInput!) {
importTenants(input: $input) {
result {
added
updated
skipped
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"tenants": [
{
"externalId": "string",
"name": "string"
}
]
}
}Response
{
"data": {
"importTenants": {
"result": {
"added": 1,
"updated": 1,
"skipped": 1
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?

