Mutation
mutation ImportCustomers($input: ImportCustomersInput!) {
importCustomers(input: $input) {
result {
added
updated
skipped
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"customers": [
{
"externalId": "string",
"fullName": "string",
"tenants": [
{
"externalId": "string",
"name": "string"
}
]
}
]
}
}Response
{
"data": {
"importCustomers": {
"result": {
"added": 1,
"updated": 1,
"skipped": 1
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
importCustomers
Upsert up to 25 customers from an external system using their externalId for idempotency. Each customer can include an optional list of tenants to associate with. Returns an ImportResult with added, updated, and skipped counts.
MUTATION
importCustomers(input: ImportCustomersInput!): ImportCustomersOutput!Arguments
input
required
Returns
result
error
Mutation
mutation ImportCustomers($input: ImportCustomersInput!) {
importCustomers(input: $input) {
result {
added
updated
skipped
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"customers": [
{
"externalId": "string",
"fullName": "string",
"tenants": [
{
"externalId": "string",
"name": "string"
}
]
}
]
}
}Response
{
"data": {
"importCustomers": {
"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?

