Set customer tenants

Replace all of a customer’s tenants at once, rather than adding or removing individually.

You can also set all tenants for a customer. Unlike the more specific add or remove mutations this is useful if you are sycing tenants and customers with Plain.

For TypeScript, the GraphQL SDK gives you a fully typed client for these operations.

This operation requires the following permissions:

• customer:edit
• customerTenantMembership:create
• customerTenantMembership:delete

Mutation

mutation setCustomerTenants($input: SetCustomerTenantsInput!) {
  setCustomerTenants(input: $input) {
    error {
      message
      type
      code
      fields {
        field
        message
        type
      }
    }
  }
}

Variables

{
  "input": {
    "customerIdentifier": {
      "emailAddress": "[e-mail]"
    },
    "tenantIdentifiers": [
      {
        "externalId": "team_123"
      },
      {
        "externalId": "team_456"
      }
    ]
  }
}