Delete an account

Deleting an account unlinks it from all of its customers and removes any associated account fields. Threads previously linked to the account retain a reference to the deletion record but are no longer routed via it.

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

An account is identified by either its Plain accountId or its externalId. This operation requires the following permissions:

tenant:delete

Mutation

mutation deleteAccount($input: DeleteAccountInput!) {
  deleteAccount(input: $input) {
    account {
      id
      name
    }
    error {
      message
      type
      code
      fields {
        field
        message
        type
      }
    }
  }
}

Variables

{
  "input": {
    "accountIdentifier": {
      "externalId": "team_123"
    }
  }
}

GraphQL API

Building Agents

Agent integrations

Webhooks

Channels

Customer Cards

UI Components

Security

Changelog