Remove customers from tenants

You can remove customers from multiple tenants in one API call.

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

When selecting the customer you can chose how to identify them. You can use the customer’s email, externalId or id. This operation requires the following permissions:

customer:edit
customerTenantMembership:delete

Mutation

mutation removeCustomerFromTenants($input: RemoveCustomerFromTenantsInput!) {
  removeCustomerFromTenants(input: $input) {
    error {
      message
      type
      code
      fields {
        field
        message
        type
      }
    }
  }
}

Variables

{
  "input": {
    "customerIdentifier": {
      "emailAddress": "jane@aol.com"
    },
    "tenantIdentifiers": [
      {
        "externalId": "team_123"
      },
      {
        "externalId": "team_456"
      }
    ]
  }
}

GraphQL API

Building Agents

Agent integrations

Webhooks

Channels

Customer Cards

UI Components

Security

Changelog

Remove customers from tenants