> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Kustomer

The Kustomer connector lets your AI agent act in each user's Kustomer account. Each user connects their own Kustomer access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 26 tools.

**Authentication:** Bearer Token
**Categories:** Customer Support, CRM & Sales
**Tools:** 26: 17 read, 9 write, 0 destructive
**Users sign in with:** Access token
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=KUSTOMER)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Kustomer connection

   In **AgentKit > Connections**, create a Kustomer connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'kustomer'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Kustomer:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'kustomer_current_user_get',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "kustomer"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Kustomer:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="kustomer_current_user_get",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Kustomer credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'kustomer_companies_list',
  toolInput: {},
  connector: 'kustomer',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="kustomer_companies_list",
    tool_input={},
    connection_name="kustomer",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `kustomer_companies_list`

List Companies · Read-only

List companies, optionally by name or external ID.
Returns data[] of companies with name, externalId, domains, emails, phones and tags.
Use kustomer_companies_list to find a company ID.
Needs the API key role org.permission.company.read (legacy org.user.company.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `external_id` (`string`, optional): Your external ID for the company. Example: acct-2201
- `filter` (`string`, optional): Company name to filter by. Example: Acme
- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (up to 1000). Example: 100

Example input: `{}`

### `kustomer_company_get`

Get Company · Read-only

Get one company by ID.
Returns the company's name, externalId, domains, contact details, tags and custom attributes.
Use kustomer_company_get for a known ID.
Needs the API key role org.permission.company.read (legacy org.user.company.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`string`, required): ID of the company (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf

Example input: `{"company_id":"<company_id>"}`

### `kustomer_conversation_get`

Get Conversation · Read-only

Get one conversation by ID, or several with comma-separated IDs.
Returns status, priority, channels, customer, assignment, tags, SLA metrics and message counts.
Use kustomer_conversation_get for a known ID.
Needs the API key role org.permission.conversation.read (legacy org.user.conversation.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `conversation_id` (`string`, required): ID of the conversation (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf
- `include` (`string`, optional): Set to customer to side-load the customer. Example: customer. One of: `customer`.

Example input: `{"conversation_id":"<conversation_id>"}`

### `kustomer_conversation_messages_list`

List Conversation Messages · Read-only

List the messages in a conversation.
Returns data[] of messages with channel, direction, preview, subject, sentAt, createdBy and attachments.
Use kustomer_conversation_messages_list to read a conversation. Use kustomer_conversation_notes_list for internal notes.
Needs the API key role org.permission.message.read (legacy org.user.message.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `conversation_id` (`string`, required): ID of the conversation (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf
- `channel` (`string`, optional): Only messages on this channel. Example: email. One of: `email`, `sms`, `chat`, `facebook`, `twitter-dm`, `twitter-tweet`, `voice`, `instagram`, `whatsapp`.
- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (up to 1000). Example: 100
- `sort` (`string`, optional): Sort order; prefix a field with - for descending. Example: createdAt

Example input: `{"conversation_id":"<conversation_id>"}`

### `kustomer_conversation_notes_list`

List Conversation Notes · Read-only

List the internal notes on a conversation.
Returns data[] of notes with body, userMentions, createdBy and createdAt.
Use kustomer_conversation_notes_list to read agent notes.
Needs the API key role org.permission.note.read (legacy org.user.note.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `conversation_id` (`string`, required): ID of the conversation (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf
- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (up to 1000). Example: 100
- `sort` (`string`, optional): Sort order; prefix a field with - for descending. Example: createdAt

Example input: `{"conversation_id":"<conversation_id>"}`

### `kustomer_conversations_list`

List Conversations · Read-only

List the organization's conversations with paging.
Returns data[] of conversations with name, status, priority, customer, assignedUsers, assignedTeams, tags and timestamps.
Use kustomer_conversations_list to browse. Use kustomer_search for open conversations or other filters.
Needs the API key role org.permission.conversation.read (legacy org.user.conversation.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (up to 1000). Example: 100
- `populate_linked_conversations` (`boolean`, optional): true to fill in linked conversation fields. Example: false
- `sort` (`string`, optional): Sort order; prefix a field with - for descending. Example: desc

Example input: `{}`

### `kustomer_current_user_get`

Get Current User · Read-only

Get the user behind the API key (for an API key, its machine user).
Returns data with the user id, name, email, userType and roles.
Works with any valid API key.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `kustomer_customer_conversations_list`

List Customer Conversations · Read-only

List one customer's conversations.
Returns data[] of conversations with name, status, channels, priority, assignedUsers, assignedTeams, tags and timestamps.
Use kustomer_customer_conversations_list to see a customer's history. Use kustomer_conversation_messages_list for a conversation's messages.
Needs the API key role org.permission.conversation.read (legacy org.user.conversation.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): ID of the customer (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf

Example input: `{"customer_id":"<customer_id>"}`

### `kustomer_customer_get`

Get Customer · Read-only

Get one customer by ID, or several with comma-separated IDs.
Returns the customer with name, emails, phones, externalId, tags, custom attributes and conversation counts.
Use kustomer_customer_get for a known ID. Use kustomer_customer_get_by_email to find by email.
Needs the API key role org.permission.customer.read (legacy org.user.customer.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): ID of the customer (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf
- `include` (`string`, optional): Set to company to side-load the customer's company. Example: company. One of: `company`.

Example input: `{"customer_id":"<customer_id>"}`

### `kustomer_customer_get_by_email`

Get Customer by Email · Read-only

Find a customer by email address.
Returns the matching customer, or 404 when no customer has that email.
Use kustomer_customer_get_by_email before kustomer_customer_create to avoid duplicates.
Needs the API key role org.permission.customer.read (legacy org.user.customer.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `email` (`string`, required): Customer email address. Example: jane@example.com
- `include` (`string`, optional): Set to company to side-load the customer's company. Example: company. One of: `company`.

Example input: `{"email":"<email>"}`

### `kustomer_customer_messages_list`

List Customer Messages · Read-only

List messages to and from one customer across conversations.
Returns data[] of messages with channel, direction, preview, subject, sentAt and conversation.
Use kustomer_customer_messages_list for a customer's recent messages.
Needs the API key role org.permission.message.read (legacy org.user.message.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): ID of the customer (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf
- `channel` (`string`, optional): Only messages on this channel. Example: email. One of: `email`, `sms`, `chat`, `facebook`, `twitter-dm`, `twitter-tweet`, `voice`, `instagram`, `whatsapp`.
- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (up to 1000). Example: 100
- `sort` (`string`, optional): Sort order; prefix a field with - for descending. Example: -createdAt

Example input: `{"customer_id":"<customer_id>"}`

### `kustomer_customer_notes_list`

List Customer Notes · Read-only

List internal notes on one customer's conversations.
Returns data[] of notes with body, createdBy, conversation and createdAt.
Use kustomer_customer_notes_list to read agent notes about a customer.
Needs the API key role org.permission.note.read (legacy org.user.note.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): ID of the customer (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf
- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (up to 1000). Example: 100

Example input: `{"customer_id":"<customer_id>"}`

### `kustomer_customers_list`

List Customers · Read-only

List customers, by default newest activity first, with paging.
Returns data[] of customers (id, attributes with name, emails, phones, tags, lastActivityAt) plus links and meta.
Use kustomer_customers_list to browse. Use kustomer_search for filtered queries and kustomer_customer_get_by_email to look up one person.
Needs the API key role org.permission.customer.read (legacy org.user.customer.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (up to 1000). Example: 100
- `sort` (`string`, optional): Sort order; prefix a field with - for descending. Example: -createdAt

Example input: `{}`

### `kustomer_message_get`

Get Message · Read-only

Get one message by ID.
Returns channel, direction, preview, subject, meta (such as email addresses), attachments, conversation and customer.
Use kustomer_message_get for a full message.
Needs the API key role org.permission.message.read (legacy org.user.message.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `message_id` (`string`, required): ID of the message (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf

Example input: `{"message_id":"<message_id>"}`

### `kustomer_search`

Search · Read-only

Search customers, conversations, messages, companies or notes with attribute filters, sorting and paging (records updated in the last 2 years).
Returns data[] of the chosen record type plus meta.total; at most 10,000 matches can be paged.
Use kustomer_search for filtered queries such as open conversations or customers by attribute. Use the list tools to browse without filters.
Needs the API key role org.permission.search.create or org.permission.search.update (legacy org.user.search.read or org.admin.search.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `query_context` (`string`, required): Record type to return: customer, conversation, message, company, note, kobject (or kobject_<klassName>), conversation_time, work_session or work_item. Example: conversation
- `and` (`array`, optional): Criteria that must all match; each is {"<attribute>": {"<operator>": value}} with operators such as equals, contains, gte, lte, gt, lt. Example: [{"conversation_status": {"equals": "open"}}, {"conversation_updated_at": {"gte": "2026-11-01T00:00:00Z"}}]
- `or` (`array`, optional): Criteria where any one must match, same shape as and. Example: [{"customer_emails": {"equals": "jane@example.com"}}, {"customer_phones": {"equals": "+15555550100"}}]
- `page` (`integer`, optional): Page number. Example: 1
- `page_size` (`integer`, optional): Results per page, up to 500; 0 returns only counts. Example: 100
- `sort` (`array`, optional): Sort order as [{"<attribute>": "asc|desc"}]. Example: [{"conversation_updated_at": "desc"}]
- `time_zone` (`string`, optional): Time zone for date-only values (default GMT). Example: America/New_York

Example input: `{"query_context":"<query_context>"}`

### `kustomer_teams_list`

List Teams · Read-only

List the organization's teams.
Returns data[] of teams with name, displayName, members and roleGroups.
Use kustomer_teams_list to find team IDs for assignment.
Needs the API key role org.permission.team.read (legacy org.user.team.read or org.admin.team.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `deleted` (`boolean`, optional): false to return only teams that are not deleted. Example: false
- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (up to 1000). Example: 100

Example input: `{}`

### `kustomer_users_list`

List Users · Read-only

List the organization's users (agents, machine users and collaborators).
Returns data[] of users with name, email, userType, roles and teams.
Use kustomer_users_list to find user IDs for assignment.
Needs the API key role org.permission.user.read (legacy org.user.read); without it Kustomer returns 401.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `deleted` (`boolean`, optional): true for only deactivated users, false for only active ones. Example: false
- `email` (`string`, optional): Only the user with this email. Example: agent@example.com
- `page` (`integer`, optional): Page number, starting at 1. Example: 2
- `page_size` (`integer`, optional): Results per page (up to 1000). Example: 100
- `pending` (`boolean`, optional): true for only users with a pending invitation, false for only active ones. Example: false
- `user_type` (`string`, optional): user (full users), machine (API users) or limited (collaborators). Example: user. One of: `user`, `machine`, `limited`.

Example input: `{}`

### `kustomer_company_create`

Create Company · Write

Create a company to group customers.
Returns the new company with its id.
Use kustomer_company_create, then set company on customers with kustomer_customer_update.
Needs the API key role org.permission.company.create (legacy org.user.company.write); without it Kustomer returns 401.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Company name (3 to 256 characters). Example: Acme Inc
- `domains` (`array`, optional): Domains, each {"domain": ...}. Example: [{"domain": "acme.com"}]
- `emails` (`array`, optional): Emails, each {"email": ..., "type": "work"}. Example: [{"type": "work", "email": "billing@acme.com"}]
- `external_id` (`string`, optional): Your system's ID for the company. Example: acct-2201
- `phones` (`array`, optional): Phones, each {"phone": ..., "type": "work"}. Example: [{"type": "work", "phone": "+15555550101"}]
- `tags` (`array`, optional): Tag names. Example: ["enterprise"]

Example input: `{"name":"<name>"}`

### `kustomer_company_update`

Update Company · Write

Update a company; the attributes you send are merged in.
Returns the updated company.
Use kustomer_company_update to change a company's name, domains or tags.
Needs the API key role org.permission.company.update (legacy org.user.company.write); without it Kustomer returns 401.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `company_id` (`string`, required): ID of the company to update (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf
- `domains` (`array`, optional): Domains, each {"domain": ...}. Example: [{"domain": "acme.com"}]
- `emails` (`array`, optional): Emails, each {"email": ..., "type": "work"}. Example: [{"type": "work", "email": "billing@acme.com"}]
- `external_id` (`string`, optional): Your system's ID for the company. Example: acct-2201
- `name` (`string`, optional): Company name (3 to 256 characters). Example: Acme Incorporated
- `phones` (`array`, optional): Phones, each {"phone": ..., "type": "work"}. Example: [{"type": "work", "phone": "+15555550101"}]
- `tags` (`array`, optional): Tag names. Example: ["enterprise"]

Example input: `{"company_id":"<company_id>"}`

### `kustomer_conversation_create`

Create Conversation · Write

Create a conversation for a customer; nothing is sent to the customer.
Returns the new conversation with its id.
Use kustomer_conversation_create, then kustomer_conversation_message_create to add messages or kustomer_conversation_note_create for internal notes.
Needs the API key role org.permission.conversation.create (legacy org.user.conversation.write); without it Kustomer returns 401.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `customer` (`string`, required): ID of the customer the conversation belongs to. Example: 5faaf4a6ea0cb48cd0801bbe
- `assigned_teams` (`array`, optional): Team IDs to assign (up to 10). Example: ["5faaf4a6ea0cb48cd0801bc2"]
- `assigned_users` (`array`, optional): User IDs to assign (up to 10). Example: ["5faaf4a6ea0cb48cd0801bc1"]
- `custom` (`object`, optional): Custom attributes with type suffixes. Example: {"orderNumberStr": "1001"}
- `direction` (`string`, optional): in if the customer started it, out if your team did. Example: in. One of: `in`, `out`.
- `external_id` (`string`, optional): Your thread ID. Example: thread-88231
- `name` (`string`, optional): Conversation subject shown to agents. Example: Order 1001 arrived damaged
- `priority` (`integer`, optional): Priority from 1 (lowest) to 5 (highest). Example: 3
- `status` (`string`, optional): open or done (update also allows snoozed). Example: open. One of: `open`, `done`.
- `tags` (`array`, optional): Tag names (up to 20). Example: ["damaged"]

Example input: `{"customer":"<customer>"}`

### `kustomer_conversation_message_create`

Create Conversation Message · Write

Record a message in a conversation, for example from a custom channel; this logs the message and does not send it to the customer.
Returns the new message with its id.
Use kustomer_conversation_message_create to import messages. Use kustomer_conversation_note_create for internal notes.
Needs the API key role org.permission.message.create (legacy org.user.message.write); without it Kustomer returns 401.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app` (`string`, required): Name of the app or system the message comes from. Example: acme-inbox
- `channel` (`string`, required): Message channel. Example: chat. One of: `email`, `sms`, `chat`, `facebook`, `twitter-dm`, `twitter-tweet`, `voice`, `instagram`, `whatsapp`.
- `conversation_id` (`string`, required): ID of the conversation (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf
- `direction` (`string`, optional): in for a customer message, out for one from your team. Example: in. One of: `in`, `out`.
- `external_id` (`string`, optional): Your message ID, so it is imported only once. Example: msg-55120
- `preview` (`string`, optional): Message text (up to 10,240 characters). Example: My order arrived damaged.
- `sent_at` (`string`, optional): When the message was sent (ISO 8601). Example: 2026-11-15T10:00:00Z
- `subject` (`string`, optional): Subject line. Example: Order 1001

Example input: `{"app":"<app>","channel":"email","conversation_id":"<conversation_id>"}`

### `kustomer_conversation_note_create`

Create Conversation Note · Write

Add an internal note to a conversation; notes are visible to agents only.
Returns the new note with its id.
Use kustomer_conversation_note_create to leave context for agents.
Needs the API key role org.permission.note.create (legacy org.user.note.read); without it Kustomer returns 401.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `body` (`string`, required): Note text (1 to 10,240 characters). Example: Customer sent photos; approved replacement.
- `conversation_id` (`string`, required): ID of the conversation (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf
- `external_id` (`string`, optional): Your note ID. Example: note-771
- `user_mentions` (`array`, optional): Users or teams to mention, each {"user": id} or {"team": id}. Example: [{"user": "5faaf4a6ea0cb48cd0801bc1"}]

Example input: `{"body":"<body>","conversation_id":"<conversation_id>"}`

### `kustomer_conversation_tags_add`

Add Conversation Tags · Write

Add tags to a conversation by tag name, creating tags that do not exist yet.
Returns the conversation with its updated tags.
Use kustomer_conversation_tags_add to tag without resending existing tags.
Needs the API key role org.permission.conversation.update (legacy org.user.conversation.write); without it Kustomer returns 401.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `conversation_id` (`string`, required): ID of the conversation (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf
- `tags` (`array`, required): Tag names to add. Example: ["refund-requested"]

Example input: `{"conversation_id":"<conversation_id>","tags":["refund-requested"]}`

### `kustomer_conversation_update`

Update Conversation · Write

Update a conversation's status, priority, assignment, tags or custom attributes; the attributes you send are merged in.
Returns the updated conversation.
Use kustomer_conversation_update to close, reassign or reprioritize. Use kustomer_conversation_tags_add to add tags without replacing the list.
Needs the API key role org.permission.conversation.update (legacy org.user.conversation.write); without it Kustomer returns 401.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `conversation_id` (`string`, required): ID of the conversation to update (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf
- `assigned_teams` (`array`, optional): Team IDs to assign (up to 10). Example: ["5faaf4a6ea0cb48cd0801bc2"]
- `assigned_users` (`array`, optional): User IDs to assign (up to 10). Example: ["5faaf4a6ea0cb48cd0801bc1"]
- `custom` (`object`, optional): Custom attributes with type suffixes. Example: {"orderNumberStr": "1001"}
- `direction` (`string`, optional): in if the customer started it, out if your team did. Example: in. One of: `in`, `out`.
- `external_id` (`string`, optional): Your thread ID. Example: thread-88231
- `name` (`string`, optional): Conversation subject shown to agents. Example: Order 1001 arrived damaged
- `priority` (`integer`, optional): Priority from 1 (lowest) to 5 (highest). Example: 3
- `status` (`string`, optional): open, snoozed or done. Example: done. One of: `open`, `snoozed`, `done`.
- `tags` (`array`, optional): Tag names (up to 20). Example: ["damaged"]

Example input: `{"conversation_id":"<conversation_id>"}`

### `kustomer_customer_create`

Create Customer · Write

Create a customer record.
Returns the new customer with its id.
Use kustomer_customer_create after kustomer_customer_get_by_email finds nothing. Use kustomer_customer_update to change an existing customer.
Needs the API key role org.permission.customer.create (legacy org.user.customer.write); without it Kustomer returns 401.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `company` (`string`, optional): ID of the company the customer belongs to. On update, leaving it empty unlinks the customer from its company, so resend the current value. Example: 5faaf4a6ea0cb48cd0801bc0
- `custom` (`object`, optional): Custom attributes; names end in a type suffix such as Str, Num, Bool, At or Url. Example: {"loyaltyTierStr": "gold"}
- `emails` (`array`, optional): Email addresses (up to 10), each {"email": ..., "type": "home|work|other"}. Example: [{"type": "work", "email": "jane@example.com"}]
- `external_id` (`string`, optional): Your system's ID for the customer, unique in Kustomer. Example: crm-10293
- `locale` (`string`, optional): Locale, such as en_US. Example: en_US
- `name` (`string`, optional): Customer's full name. Example: Jane Doe
- `phones` (`array`, optional): Phone numbers (up to 10), each {"phone": ..., "type": "mobile|home|work|fax|other"}. Example: [{"type": "mobile", "phone": "+15555550100"}]
- `tags` (`array`, optional): Tag names (up to 20). Example: ["vip"]
- `time_zone` (`string`, optional): IANA time zone. Example: America/New_York
- `username` (`string`, optional): Username. Example: janed

Example input: `{}`

### `kustomer_customer_update`

Update Customer · Write

Update a customer; the attributes you send are merged into the record, except that leaving out company unlinks the customer from its company. Lists such as emails replace the stored list.
Returns the updated customer.
Use kustomer_customer_update to change details or tags.
Needs the API key role org.permission.customer.update (legacy org.user.customer.write); without it Kustomer returns 401.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `customer_id` (`string`, required): ID of the customer to update (24-character Kustomer ID). Example: 5faaf4a6ea0cb48cd0801bbf
- `company` (`string`, optional): ID of the company the customer belongs to. On update, leaving it empty unlinks the customer from its company, so resend the current value. Example: 5faaf4a6ea0cb48cd0801bc0
- `custom` (`object`, optional): Custom attributes; names end in a type suffix such as Str, Num, Bool, At or Url. Example: {"loyaltyTierStr": "gold"}
- `emails` (`array`, optional): Email addresses (up to 10), each {"email": ..., "type": "home|work|other"}. Example: [{"type": "work", "email": "jane@example.com"}]
- `external_id` (`string`, optional): Your system's ID for the customer, unique in Kustomer. Example: crm-10293
- `locale` (`string`, optional): Locale, such as en_US. Example: en_US
- `name` (`string`, optional): Customer's full name. Example: Jane Doe
- `phones` (`array`, optional): Phone numbers (up to 10), each {"phone": ..., "type": "mobile|home|work|fax|other"}. Example: [{"type": "mobile", "phone": "+15555550100"}]
- `tags` (`array`, optional): Tag names (up to 20). Example: ["vip"]
- `time_zone` (`string`, optional): IANA time zone. Example: America/New_York
- `username` (`string`, optional): Username. Example: janed

Example input: `{"customer_id":"<customer_id>"}`

## Related

Other Customer Support connectors ([all 38](/agentkit/connectors/?category=customer-support)):

- [ServiceNow](/agentkit/connectors/servicenow/): Scalekit connector, OAuth, 112 tools
- [Zendesk](/agentkit/connectors/zendeskoauth/): Scalekit connector, OAuth, 137 tools
- [Jira Service Management](/agentkit/connectors/jiraservicemanagement/): Scalekit connector, OAuth, 72 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
