Actions

53 actions

Action

Description

List Customers

Retrieve a paginated list of customers

Get Customer By ID

Retrieve a single customer by ID

Create Customer

Create a new customer

Update Customer

Update an existing customer by ID (full replacement)

Update Customer Attributes

Partially update a customer's attributes by ID

Delete Customer

Delete a customer by ID

List Conversations

Retrieve a paginated list of conversations

Get Conversation By ID

Retrieve a single conversation by ID

Create Conversation

Create a new conversation associated with an existing customer

Update Conversation

Update a conversation by replacing its fields (PUT semantics)

Update Conversation Attributes

Partially update a conversation's attributes using PATCH semantics

Delete Conversation

Delete a conversation by ID

List Messages

Retrieve a paginated list of messages

Get Message By ID

Retrieve a single message by ID

Create Message

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

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

Partially update message attributes by ID

Get Users

Retrieve a paginated list of org users

Get User By ID

Retrieve a single user by their unique ID

Get Multiple Users By IDs

Retrieve multiple users by a comma-separated list of IDs

Create / Invite New User

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

Update User By ID

Update an existing org user's profile or account settings

List Notes

Retrieve a paginated list of notes

Get Note By ID

Retrieve a single note by ID

Create Note

Create a new note

Update Note By ID

Replace a note by ID

Update Note Attributes By ID

Partially update note attributes by ID

Delete Note By ID

Delete a note by ID

Get Klasses

Retrieve a paginated list of klasses

Get Klass By ID

Retrieve a single klass by ID

Create Klass

Create a new klass

Update Klass By ID

Update an existing klass by ID

Delete Klass

Delete a klass by ID

Get KObjects (custom Objects)

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

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

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

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

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

Retrieve a paginated list of companies

Get Company By ID

Retrieve a single company by its unique ID

Create Company

Create a new company

Update Company Attributes

Update an existing company by ID

Get Sub-statuses

Retrieve a paginated list of sub-statuses

Create Sub-status

Create a new sub-status

Get Sub-Status By ID

Retrieve a single sub-status by its unique ID

Update Sub-Status

Update an existing sub-status by ID

Delete Sub-Status

Delete a sub-status by ID

Bulk Create Conversations

Create multiple conversations in a single request

Bulk Batch Update Conversations

Update multiple conversations in a single request

Bulk Delete Conversations

Delete multiple conversations in a single request

Query Events Associated With Your Organization

Retrieve audit log events for your organization

Find Company KObjects (custom Objects)

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)

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