Upserting tenants

When upserting a tenant you need to specify an externalId which matches the id of the tenant in your own backend.

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

For example if your product is structured in teams, then when creating a tenant for a team you’d use the team’s id as the externalId. To upsert a tenant you need the following permissions:

tenant:read
tenant:create

Mutation

mutation upsertTenant($input: UpsertTenantInput!) {
  upsertTenant(input: $input) {
    tenant {
      id
      externalId
      name
      url
    }
    error {
      message
      type
      code
      fields {
        field
        message
        type
      }
    }
  }
}

Variables

{
  "input": {
    "identifier": {
      "externalId": "team_123"
    },
    "name": "Acme",
    "externalId": "team_123",
    "url": {
      "value": "acme.com"
    }
  }
}

GraphQL API

Building Agents

Agent integrations

Webhooks

Channels

Customer Cards

UI Components

Security

Changelog