> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Kustomer

> How to set up the Kustomer connector, plus the actions that are available.

![Kustomer](https://stackone-logos.com/api/kustomer/filled/svg)

Betav1.1.0[See changelog](https://docs.stackone.com/connectors/kustomer/changelog.md)

[53 actions](#actions) · 2 auth methods

Customer Support
Ticketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/kustomer/guides/connector-profile/oauth-2-0.md)
>
> Connect using OAuth 2.0 authorization code flow. Requires registering a Kustomer app via the Apps Platform API.

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/kustomer/guides/connector-profile/api-key.md)
>
> Authenticate using a Kustomer API key with Bearer token authorization.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/kustomer/guides/link-account/oauth-2-0.md)

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/kustomer/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

53 actions

ActionDescription

List Customers`kustomer_list_customers`

Retrieve a paginated list of customers

Get Customer By ID`kustomer_get_customer_by_id`

Retrieve a single customer by ID

Create Customer`kustomer_create_customer`

Create a new customer

Update Customer`kustomer_update_customer`

Update an existing customer by ID (full replacement)

Update Customer Attributes`kustomer_update_customer_attributes`

Partially update a customer's attributes by ID

Delete Customer`kustomer_delete_customer`

Delete a customer by ID

List Conversations`kustomer_list_conversations`

Retrieve a paginated list of conversations

Get Conversation By ID`kustomer_get_conversation_by_id`

Retrieve a single conversation by ID

Create Conversation`kustomer_create_conversation`

Create a new conversation associated with an existing customer

Update Conversation`kustomer_update_conversation`

Update a conversation by replacing its fields (PUT semantics)

Update Conversation Attributes`kustomer_update_conversation_attributes`

Partially update a conversation's attributes using PATCH semantics

Delete Conversation`kustomer_delete_conversation`

Delete a conversation by ID

List Messages`kustomer_list_messages`

Retrieve a paginated list of messages

Get Message By ID`kustomer_get_message_by_id`

Retrieve a single message by ID

Create Message`kustomer_create_message`

Create a new message. Requires channel, app (channel integration identifier — not a Kustomer ID), and direction. Use lis...

Update Message By ID`kustomer_update_message_by_id`

Replace a message by ID using full PUT semantics (replaces entire resource; use update\_message\_attributes\_by\_id for part...

Update Message Attributes By ID`kustomer_update_message_attributes_by_id`

Partially update message attributes by ID

Get Users`kustomer_list_users`

Retrieve a paginated list of org users

Get User By ID`kustomer_get_user_by_id`

Retrieve a single user by their unique ID

Get Multiple Users By IDs`kustomer_get_multiple_users_by_ids`

Retrieve multiple users by a comma-separated list of IDs

Create / Invite New User`kustomer_create_invite_new_user`

Create an account for a new org user and send an invitation email

Update User By ID`kustomer_update_user_by_id`

Update an existing org user's profile or account settings

List Notes`kustomer_list_notes`

Retrieve a paginated list of notes

Get Note By ID`kustomer_get_note_by_id`

Retrieve a single note by ID

Create Note`kustomer_create_note`

Create a new note

Update Note By ID`kustomer_update_note_by_id`

Replace a note by ID

Update Note Attributes By ID`kustomer_update_note_attributes_by_id`

Partially update note attributes by ID

Delete Note By ID`kustomer_delete_note_by_id`

Delete a note by ID

Get Klasses`kustomer_list_klasses`

Retrieve a paginated list of klasses

Get Klass By ID`kustomer_get_klass_by_id`

Retrieve a single klass by ID

Create Klass`kustomer_create_klass`

Create a new klass

Update Klass By ID`kustomer_update_klass_by_id`

Update an existing klass by ID

Delete Klass`kustomer_delete_klass`

Delete a klass by ID

Get KObjects (custom Objects)`kustomer_get_kobjects`

Retrieve a paginated list of kobjects for a klass. Use list\_klasses first to get the klass name (slug) required as a pat...

Get KObject (custom Object) By ID`kustomer_get_kobject_by_id`

Retrieve a single kobject by klass name and ID. Use list\_klasses to get the klass name and get\_kobjects to get the kobje...

Create KObject`kustomer_create_kobject`

Create a new kobject (custom object instance) within a klass. Use list\_klasses to get the klass name (slug) required as...

Update KObject (custom Object) By ID`kustomer_update_kobject_by_id`

Update an existing kobject by klass name and ID. Use list\_klasses to get the klass name and get\_kobjects to get the kobj...

Delete KObject (custom Object) By ID`kustomer_delete_kobject_by_id`

Delete a kobject by klass name and ID. Use list\_klasses to get the klass name and get\_kobjects to get the kobject ID.

Get Companies`kustomer_list_companies`

Retrieve a paginated list of companies

Get Company By ID`kustomer_get_company_by_id`

Retrieve a single company by its unique ID

Create Company`kustomer_create_company`

Create a new company

Update Company Attributes`kustomer_update_company_attributes`

Update an existing company by ID

Get Sub-statuses`kustomer_list_sub_statuses`

Retrieve a paginated list of sub-statuses

Create Sub-status`kustomer_create_sub_status`

Create a new sub-status

Get Sub-Status By ID`kustomer_get_sub_status_by_id`

Retrieve a single sub-status by its unique ID

Update Sub-Status`kustomer_update_sub_status`

Update an existing sub-status by ID

Delete Sub-Status`kustomer_delete_sub_status`

Delete a sub-status by ID

Bulk Create Conversations`kustomer_bulk_create_conversations`

Create multiple conversations in a single request

Bulk Batch Update Conversations`kustomer_bulk_batch_update_conversations`

Update multiple conversations in a single request

Bulk Delete Conversations`kustomer_bulk_delete_conversations`

Delete multiple conversations in a single request

Query Events Associated With Your Organization`kustomer_list_audit_logs`

Retrieve audit log events for your organization

Find Company KObjects (custom Objects)`kustomer_find_company_kobjects`

Retrieve KObjects of a specific Klass associated with a company. Use list\_companies to get the company ID and list\_klass...

Find Customer KObjects (custom Objects)`kustomer_find_customer_kobjects`

Retrieve KObjects of a specific Klass associated with a customer. Use list\_customers to get the customer ID and list\_kla...


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.