Mutation
mutation UpdateTenantTier($input: UpdateTenantTierInput!) {
updateTenantTier(input: $input) {
tenantTierMembership {
id
tierId
tenantId
createdAt {
unixTimestamp
iso8601
}
createdBy {
__typename
... on UserActor {
__typename
}
}
updatedAt {
unixTimestamp
iso8601
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"tenantIdentifier": {}
}
}Response
{
"data": {
"updateTenantTier": {
"tenantTierMembership": {
"id": "id",
"tierId": "id",
"tenantId": "id",
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"createdBy": {
"__typename": "UserActor"
},
"updatedAt": {
"unixTimestamp": "string",
"iso8601": "string"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Mutations
updateTenantTier
Sets the tier for a single tenant, identified by its Plain ID or external ID. Pass a null tierIdentifier to remove the tenant from its current tier. Use addMembersToTier when you need to move multiple tenants at once. Requires the tierMembership:read and tierMembership:create permissions.
MUTATION
updateTenantTier(input: UpdateTenantTierInput!): UpdateTenantTierOutput!Arguments
input
required
Returns
tenantTierMembership
error
Mutation
mutation UpdateTenantTier($input: UpdateTenantTierInput!) {
updateTenantTier(input: $input) {
tenantTierMembership {
id
tierId
tenantId
createdAt {
unixTimestamp
iso8601
}
createdBy {
__typename
... on UserActor {
__typename
}
}
updatedAt {
unixTimestamp
iso8601
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"tenantIdentifier": {}
}
}Response
{
"data": {
"updateTenantTier": {
"tenantTierMembership": {
"id": "id",
"tierId": "id",
"tenantId": "id",
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"createdBy": {
"__typename": "UserActor"
},
"updatedAt": {
"unixTimestamp": "string",
"iso8601": "string"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?

