Jump to Content

Guides API Reference Changelog

v1.0

v1.0Guides API Reference Changelog

Kustomer API (v1)

Introduction
Getting started with Kustomer API
Authentication and API keys
Rate limiting
Pagination
Errors

Core Resources

About: Core Resources
Audit Logs
- Query events associated with your organizationget
Attachments
Messages
Brands
Business Schedules
Companies
Klasses
Companies (Bulk)
- Bulk create companiespost
- Bulk batch update companiesput
Conversations
Conversations (Bulk)
- Bulk create conversationspost
- Bulk batch update conversationsput
Conversations (Messages)
- Create message from conversationpost
- Get messages by conversationget
Conversations (Tags)
- Append tags to conversationpost
- Remove tags from conversationdelete
Conversations (Forwards)
- Create forward by conversationpost
- Get all forwards by conversationget
Conversations (Time)
- Get conversation times by conversationget
- Get conversation time by idsget
Notes (Conversations)
- Create note within conversationpost
Conversations (Notes)
- Get notes by conversationget
Customers (Bulk)
Customers (Conversations)
- Create conversation for customerpost
- Get conversations by customerget
Customers (Drafts)
- Get all drafts for customerget
- Create draft for customerpost
Customers (Events)
Customers (KObjects)
- Create customer KObject (custom Object)post
- Find customer KObjects (custom Objects)get
KObjects (Custom Objects)
Customers (Merges)
Customers (Messages)
- Create message by customer IDpost
- Get messages by customer IDget
Customers (Notes)
- Get notes by customer IDget
Notes
Customers (Unmasking Windows)
- Create unmasking window by customer IDpost
- Deletes unmasking window by customer IDdelete
Unmasking Windows
Customers
Custom Attributes
- Get custom attribute metadataget
- Update custom attribute metadataput
Drafts (Attachments)
Drafts
Forwards (Attachments)
KObjects (Custom Objects) (Bulk)
Media
Messages (Bulk)
- Bulk create messagespost
- Bulk batch update messagesput
Notes (Bulk)
- Bulk create notespost
- Bulk batch update notesput
Tracking Events
Search
- Create customer searchpost
Customers (Search)
Satisfaction
- Get Satisfactionsget
SLAs
- Get SLA by IDget
Spam

Knowledge Base (KB)

About: Knowledge Base
Articles (Versioning and Languages)
Articles
Articles (Schedules)
- Create article schedulepost
- Delete Article Scheduledelete
Articles (Public)
- Get Articles (Public)get
- Search Articles (Public)get
Categories
Categories (Internal)
- Create an Internal Categorypost
- Get Internal Category by IDget
Categories (Public)
- Get Categories (Public)get
- Get Category by ID (Public)get
Forms
Knowledge Bases
Tags (Knowledge Base)
Themes
Themes (Drafts and Revisions)
Themes (Theme Files)
Templates
- Get Templatesget
- Get Templates by IDget
Routes
Knowledge Bases (Custom Domains)

Queues and Routing

About: Queues and Routing
Work Items
Work Sessions (Current)
Work Sessions (by Session ID)
Work Sessions
Queues
Queue Rules
Routing User Statuses
Team Routing Settings
Metrics
- Queue metricsget

Workflows

About: Workflows
Workflows
Workflow Variables
Workflow Processes (Errors)
- Get processes (errors) by workflowget

Settings and Configurations

About: Settings and Configurations
Chat Settings
- Get chat settingsget
- Set chat settingspatch
Notifications (Logs)
- Get notifications logs settingsget
- Update notifications logs settingsput
Notifications (Settings)
- Get notification settings for current userget
- Update notification settings for current userput
Notifications
Search Filters
Search Filters (Folders)
- Create search folderpost
- Update search folder by IDput
Search Filters (Pinned)
Settings
Settings (Specific User)
Shortcuts (Catgories)
Shortcuts
Snippets
Snoozes

Apps Platform

About: Apps Platform
Apps
Cards
Hooks (Email Hooks)
Hooks (Form Hooks)
Hooks (Web Hooks)
KViews (Klass Views)
Outbound Web Hooks (Transactions)
- List Transactionsget
- List Transactions For Webhookget
Outbound Web Hooks

Access Management

About: Access Management
Auth Settings
Auth Tokens
Role Groups
Teams
Teams (By ID)
Users
Users (By ID)

Kustomer API (v1)

Introduction
Getting started with Kustomer API
Authentication and API keys
Rate limiting
Pagination
Errors

Core Resources

About: Core Resources
Audit Logs
- Query events associated with your organizationget
Attachments
Messages
Brands
Business Schedules
Companies
Klasses
Companies (Bulk)
- Bulk create companiespost
- Bulk batch update companiesput
Conversations
Conversations (Bulk)
- Bulk create conversationspost
- Bulk batch update conversationsput
Conversations (Messages)
- Create message from conversationpost
- Get messages by conversationget
Conversations (Tags)
- Append tags to conversationpost
- Remove tags from conversationdelete
Conversations (Forwards)
- Create forward by conversationpost
- Get all forwards by conversationget
Conversations (Time)
- Get conversation times by conversationget
- Get conversation time by idsget
Notes (Conversations)
- Create note within conversationpost
Conversations (Notes)
- Get notes by conversationget
Customers (Bulk)
Customers (Conversations)
- Create conversation for customerpost
- Get conversations by customerget
Customers (Drafts)
- Get all drafts for customerget
- Create draft for customerpost
Customers (Events)
Customers (KObjects)
- Create customer KObject (custom Object)post
- Find customer KObjects (custom Objects)get
KObjects (Custom Objects)
Customers (Merges)
Customers (Messages)
- Create message by customer IDpost
- Get messages by customer IDget
Customers (Notes)
- Get notes by customer IDget
Notes
Customers (Unmasking Windows)
- Create unmasking window by customer IDpost
- Deletes unmasking window by customer IDdelete
Unmasking Windows
Customers
Custom Attributes
- Get custom attribute metadataget
- Update custom attribute metadataput
Drafts (Attachments)
Drafts
Forwards (Attachments)
KObjects (Custom Objects) (Bulk)
Media
Messages (Bulk)
- Bulk create messagespost
- Bulk batch update messagesput
Notes (Bulk)
- Bulk create notespost
- Bulk batch update notesput
Tracking Events
Search
- Create customer searchpost
Customers (Search)
Satisfaction
- Get Satisfactionsget
SLAs
- Get SLA by IDget
Spam

Knowledge Base (KB)

About: Knowledge Base
Articles (Versioning and Languages)
Articles
Articles (Schedules)
- Create article schedulepost
- Delete Article Scheduledelete
Articles (Public)
- Get Articles (Public)get
- Search Articles (Public)get
Categories
Categories (Internal)
- Create an Internal Categorypost
- Get Internal Category by IDget
Categories (Public)
- Get Categories (Public)get
- Get Category by ID (Public)get
Forms
Knowledge Bases
Tags (Knowledge Base)
Themes
Themes (Drafts and Revisions)
Themes (Theme Files)
Templates
- Get Templatesget
- Get Templates by IDget
Routes
Knowledge Bases (Custom Domains)

Queues and Routing

About: Queues and Routing
Work Items
Work Sessions (Current)
Work Sessions (by Session ID)
Work Sessions
Queues
Queue Rules
Routing User Statuses
Team Routing Settings
Metrics
- Queue metricsget

Workflows

About: Workflows
Workflows
Workflow Variables
Workflow Processes (Errors)
- Get processes (errors) by workflowget

Settings and Configurations

About: Settings and Configurations
Chat Settings
- Get chat settingsget
- Set chat settingspatch
Notifications (Logs)
- Get notifications logs settingsget
- Update notifications logs settingsput
Notifications (Settings)
- Get notification settings for current userget
- Update notification settings for current userput
Notifications
Search Filters
Search Filters (Folders)
- Create search folderpost
- Update search folder by IDput
Search Filters (Pinned)
Settings
Settings (Specific User)
Shortcuts (Catgories)
Shortcuts
Snippets
Snoozes

Apps Platform

About: Apps Platform
Apps
Cards
Hooks (Email Hooks)
Hooks (Form Hooks)
Hooks (Web Hooks)
KViews (Klass Views)
Outbound Web Hooks (Transactions)
- List Transactionsget
- List Transactions For Webhookget
Outbound Web Hooks

Access Management

About: Access Management
Auth Settings
Auth Tokens
Role Groups
Teams
Teams (By ID)
Users
Users (By ID)

About: Knowledge Base

This category describes endpoints related to your Kustomer knowledge base data.

To learn more, see Knowledge base overview in the Kustomer Help Center.