Customer groups

Segment customers into named groups you define, separate from companies and tenants.

Customer groups can be used to group and segment your customers. For example you could organize your customers by their tier “Free”, “Growth”, “Enterprise” or make use of groups to keep track of customers trialing beta features.

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

Customers can belong to one or many groups. You can filter customer threads by group, so you can focus on a subset of them.

You can add customers to groups through the API, or in the Plain app.

This guide assumes you’ve already created some customer groups in Settings → Customer Groups.

Add a customer to groups

A customer can be added to a customer group using the addCustomerToCustomerGroup mutation.

When to call this API depends on what your customer groups represent. If you group customers by pricing tier, call it every time their tier changes.

This operation requires the following permissions:

• customer:create
• customer:edit

Mutation

mutation addCustomerToCustomerGroup($input: AddCustomerToCustomerGroupsInput!) {
  addCustomerToCustomerGroups(input: $input) {
    customerGroupMemberships {
      customerGroup {
        id
        name
        key
        color
      }
    }
    error {
      message
      code
      type
      fields {
        field
        message
        type
      }
    }
  }
}

Variables

{
  "input": {
    "customerId": "c_01GTC6ZHCMAGR06FMPN9VY5J95",
    "customerGroupIdentifiers": [
      {
        "customerGroupKey": "free-tier"
      },
      {
        "customerGroupKey": "design-partner"
      }
    ]
  }
}

If you prefer you can also use the customer group id instead of the key. You can do this like so:

Variables

{
  "input": {
    "customerId": "c_01GTC6ZHCMAGR06FMPN9VY5J95",
    "customerGroupIdentifiers": [
      {
        "customerGroupId": "cg_01GX8H2BWS7Z4EP9RRGMF9NXX2"
      }
    ]
  }
}

Response

{
  "data": {
    "customerGroupMemberships": [
      {
        "customerGroup": {
          "id": "cg_01GX8H2BWS7Z4EP9RRGMF9NXX2",
          "name": "Free Tier",
          "key": "free-tier",
          "color": "#1D4ED8"
        }
      },
      {
        "customerGroup": {
          "id": "cg_05GXF4FGGS2Z7EW9RRGKL9NLL9",
          "name": "Design partner",
          "key": "design-partner",
          "color": "#06B6D4"
        }
      }
    ],
    "error": null
  }
}

Remove a customer from groups

A customer can be removed from a customer group by using the removeCustomerFromGroup mutation.

Mutation

mutation removeCustomerFromCustomerGroup($input: RemoveCustomerFromCustomerGroupsInput!) {
  removeCustomerFromCustomerGroups(input: $input) {
    error {
      message
      code
      type
      fields {
        field
        message
        type
      }
    }
  }
}

Variables

{
  "input": {
    "customerId": "c_01GTC6ZHCMAGR06FMPN9VY5J95",
    "customerGroupIdentifiers": [
      {
        "customerGroupKey": "free-tier"
      },
      {
        "customerGroupKey": "design-partner"
      }
    ]
  }
}

Response

{
  "data": {
    "error": null
  }
}

If you prefer you can also use the customer group id instead of the key. You can do this like so:

Variables

{
  "input": {
    "customerId": "c_01GTC6ZHCMAGR06FMPN9VY5J95",
    "customerGroupIdentifiers": [
      {
        "customerGroupId": "cg_01GX8H2BWS7Z4EP9RRGMF9NXX2"
      }
    ]
  }
}