Mutation
mutation UpsertTenantField($input: UpsertTenantFieldInput!) {
upsertTenantField(input: $input) {
tenantField {
id
source
externalFieldId
value {
__typename
... on TenantFieldStringValue {
__typename
}
}
createdAt {
unixTimestamp
iso8601
}
createdBy {
__typename
... on UserActor {
__typename
}
}
}
result
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"tenantFieldIdentifier": {
"tenantId": "id",
"externalFieldId": "id"
},
"type": "STRING_TYPE"
}
}Response
{
"data": {
"upsertTenantField": {
"tenantField": {
"id": "id",
"source": "string",
"externalFieldId": "id",
"value": {
"__typename": "TenantFieldStringValue"
},
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"createdBy": {
"__typename": "UserActor"
}
},
"result": "UPDATED",
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
upsertTenantField
Sets or updates a field value for a specific tenant. Identify the target field using tenantFieldIdentifier (tenant ID + external field ID) and pass exactly one value argument matching the schema’s type (e.g. stringValue, numberValue, booleanValue, arrayValue, dateValue, or userReferenceValues). Requires tenant:edit permission.
MUTATION
upsertTenantField(input: UpsertTenantFieldInput!): UpsertTenantFieldOutput!Arguments
input
required
Returns
tenantField
result
error
Mutation
mutation UpsertTenantField($input: UpsertTenantFieldInput!) {
upsertTenantField(input: $input) {
tenantField {
id
source
externalFieldId
value {
__typename
... on TenantFieldStringValue {
__typename
}
}
createdAt {
unixTimestamp
iso8601
}
createdBy {
__typename
... on UserActor {
__typename
}
}
}
result
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"tenantFieldIdentifier": {
"tenantId": "id",
"externalFieldId": "id"
},
"type": "STRING_TYPE"
}
}Response
{
"data": {
"upsertTenantField": {
"tenantField": {
"id": "id",
"source": "string",
"externalFieldId": "id",
"value": {
"__typename": "TenantFieldStringValue"
},
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"createdBy": {
"__typename": "UserActor"
}
},
"result": "UPDATED",
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?

