Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.plain.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Using TypeScript? Check out our GraphQL SDK for a fully typed client.
You can remove customers from multiple tenants in one API call. When selecting the customer you can chose how to identify them. You can use the customer’s email, externalId or id. For this mutation you need 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"
      }
    ]
  }
}