JUMP TOKustomer API (v1)IntroductionGetting started with Kustomer APIAuthentication and API keysRate limitingPaginationErrorsCore ResourcesAbout: Core ResourcesAudit LogsQuery events associated with your organizationgetAttachmentsCreate attachmentpostUpdate or upsert attachmentputGet attachments by ID [Outbound Only]getGet attachment by message ID and attachment ID (inbound or outbound)getMessagesRedact a messagepostCreate messagepostGet messagesgetGet message by IDgetUpdate message by IDputUpdate message attributes by IDpatchGet a Message by External IDgetBrandsGet brandsgetCreate brandpostGet default brandgetGet brand by IDgetUpdate brandpatchBusiness SchedulesGet all business schedulesgetCreate a business schedulepostGet default business schedulegetGet business schedule by IDgetUpdate business schedule by IDputDelete a business schedule by IDdeleteCompaniesCreate companypostGet companiesgetGet company by IDgetUpdate company attributesputFind company KObjects (custom Objects)getKlassesCreate KlasspostGet KlassesgetGet Klass by IDgetUpdate Klass by IDputDelete KlassdeleteCompanies (Bulk)Bulk create companiespostBulk batch update companiesputConversationsCreate conversationpostGet conversationsgetGet conversation by IDgetUpdate conversationputUpdate conversation attributespatchDelete conversationdeleteGet conversation by external IDgetGet conversation attachmentsgetGet conversation eventsgetConversations (Bulk)Bulk create conversationspostBulk batch update conversationsputConversations (Messages)Create message from conversationpostGet messages by conversationgetConversations (Tags)Append tags to conversationpostRemove tags from conversationdeleteConversations (Forwards)Create forward by conversationpostGet all forwards by conversationgetConversations (Time)Get conversation times by conversationgetGet conversation time by idsgetNotes (Conversations)Create note within conversationpostConversations (Notes)Get notes by conversationgetCustomers (Bulk)Bulk create customerspostBulk batch update customersputBulk delete customersdeleteCustomers (Conversations)Create conversation for customerpostGet conversations by customergetCustomers (Drafts)Get all drafts for customergetCreate draft for customerpostCustomers (Events)Get customer eventgetGet all events by customer for sessiongetGet all customer events (deprecated)getGet all customer sessionsgetCustomers (KObjects)Create customer KObject (custom Object)postFind customer KObjects (custom Objects)getKObjects (Custom Objects)Get KObjects (custom objects)getCreate KObjectpostGet KObject (custom object) by IDgetUpdate KObject (custom object) by IDputDelete KObject (custom object) by IDdeleteGet KObject by external IDgetCustomers (Merges)Create customer mergepostGet customer mergegetGet customer merges by customer IDgetCustomers (Messages)Create message by customer IDpostGet messages by customer IDgetCustomers (Notes)Get notes by customer IDgetNotesCreate notepostGet notesgetGet note by IDgetUpdate note by IDputUpdate note attributes by IDpatchDelete note by IDdeleteCustomers (Unmasking Windows)Create unmasking window by customer IDpostDeletes unmasking window by customer IDdeleteUnmasking WindowsCustomersCreate customerpostGet customersgetGet customer by IDgetUpdate customerputUpdate customer attributespatchDelete customerdeleteGet customer by emailgetGet customer by external IDgetGet customer by phone numbergetCustom AttributesGet custom attribute metadatagetUpdate custom attribute metadataputDrafts (Attachments)Create draft attachmentpostGet draft attachmentsgetGet draft attachmentgetDelete draft attachmentdeleteDraftsGet draft forward by IDgetUpdate draft forwardputGet outbound accountsgetUpdate draftputDelete draftdeleteForwards (Attachments)Create forward attachmentpostGet forward attachmentsgetGet forward attachmentgetDelete Forward AttachmentdeleteKObjects (Custom Objects) (Bulk)Bulk create KObjects (custom objects)postBulk batch update KObjects (custom objects)putBulk delete KObjects (custom objects)deleteMediaCreate mediapostGet media by IDgetUpdate media by IDputMessages (Bulk)Bulk create messagespostBulk batch update messagesputNotes (Bulk)Bulk create notespostBulk batch update notesputTracking EventsCreate tracking eventpostCreate tracking identitypostCreate tracking identity and track eventpostSearchCreate customer searchpostCustomers (Search)SatisfactionGet SatisfactionsgetSLAsGet SLA by IDgetSpamUpsert spam senderputGet spam sendersgetDelete a spam senderdeleteKnowledge Base (KB)About: Knowledge BaseArticles (Versioning and Languages)Create a VersionpostGet Article Versions by LanguagegetDelete Versions of a LanguagedeleteGet Article Version by IDgetUpdate Latest Published Article VersionputUpdate a Draft VersionputDelete a Draft VersiondeleteArticlesCreate an ArticlepostGet ArticlesgetGet Article by IDgetUpdate ArticleputSearch ArticlesgetUpdate Article ScheduleputArticles (Schedules)Create article schedulepostDelete Article ScheduledeleteArticles (Public)Get Articles (Public)getSearch Articles (Public)getCategoriesCreate a CategorypostGet CategoriesgetGet Internal CategoriesgetGet Category by IDgetUpdate CategoryputCategories (Internal)Create an Internal CategorypostGet Internal Category by IDgetCategories (Public)Get Categories (Public)getGet Category by ID (Public)getFormsCreate a FormpostGet FormsgetGet Form by IDgetUpdate FormputDelete FormdeleteGet Form by ID (Public)getKnowledge BasesCreate Knowledge BasepostGet Knowledge Base by IDgetUpdate Knowledge BasepatchTags (Knowledge Base)Get tagsgetCreate tagpostGet Tags by IDgetUpdate Tag by ID.patchThemesGet ThemesgetCreate a ThemepostGet Themes by IDgetGet Active Theme (Public)getGet Theme by ID (Public)getCreate Revision Theme FilepostThemes (Drafts and Revisions)Get Theme RevisionsgetGet Theme Revision by IDgetDelete Theme Draft RevisiondeleteCreate Theme Draft RevisionpostUpdate Theme Draft RevisionputThemes (Theme Files)Get Theme Files by RevisiongetGet Theme Files (Public)getGet Theme File by RevisiongetUpdate Revision Theme FileputDelete Revision Theme FiledeleteTemplatesGet TemplatesgetGet Templates by IDgetRoutesGet Route by URL (Public)getCreate a RoutepostGet RoutesgetGet Routes by Article IDgetCreate a Category RoutepostGet Routes by Category IDgetGet Route by IDgetUpdate RouteputDelete Route by IDdeleteKnowledge Bases (Custom Domains)Get Custom Domain By IDgetGet Custom DomainsgetUpdate Custom DomainputDelete Custom DomaindeleteCreate Custom DomainpostQueues and RoutingAbout: Queues and RoutingWork ItemsGet work items by conversationgetCreate work itempostGet work itemsgetGet work itemgetUpdate work itemputGet work items in a queuegetGet next work items in a queuegetWork Sessions (Current)Get current work sessiongetUpdate current work sessionputGet work items in current work sessiongetGet current work session by user IDgetWork Sessions (by Session ID)Get work session by IDgetUpdate work session by IDputGet work items By work sessiongetWork SessionsGet work sessionsgetGet work sessions by user IDgetGet work sessions by queue IDgetQueuesCreate queuepostGet queuesgetGet queuegetUpdate queue by IDputQueue RulesCreate queue rulepostGet queue rulesgetGet queue rulegetUpdate queue ruleputDelete queue ruledeleteGet queue criteriagetUpdate queue rule orderputRouting User StatusesCreate routing user statuspostGet routing user statusesgetGet routing user statusgetUpdate routing user statusputTeam Routing SettingsGet all team routing settingsgetGet team routing settingsgetUpdate team routing settingsputGet current's user team routing settingsgetMetricsQueue metricsgetWorkflowsAbout: WorkflowsWorkflowsGet workflowsgetCreate a workflowpostUpdate a workflow based on the IDputGet a workflow based on the IDgetWorkflow VariablesCreate a workflow variable for a workflowpostGet all variables for a workflowgetUpdate a workflow variableputGet a workflow variablegetDelete a workflow variabledeleteWorkflow Processes (Errors)Get processes (errors) by workflowgetSettings and ConfigurationsAbout: Settings and ConfigurationsChat SettingsGet chat settingsgetSet chat settingspatchNotifications (Logs)Get notifications logs settingsgetUpdate notifications logs settingsputNotifications (Settings)Get notification settings for current usergetUpdate notification settings for current userputNotificationsGet notificationsgetUpdate notificationsputDelete notificationsdeleteSearch FiltersCreate Saved SearchpostGet all searchesgetGet saved search by IDgetUpdate search by IDputDelete search by IDdeleteDelete search folder by IDdeleteGet search positionsgetUpdate search positionsputGet schema for searchesgetSearch Filters (Folders)Create search folderpostUpdate search folder by IDputSearch Filters (Pinned)Pin searchpostGet all pinned searchesgetDelete pinned search by IDdeleteSettingsGet settingsgetGet user settingsgetGet user settings for current usergetGet a settinggetUpdate a settingputSettings (Specific User)Get specific user settinggetUpdate specific user settingputGet specific user setting for current usergetUpdate specific user setting for current userputShortcuts (Catgories)Create a shortcut categorypostGet shortcut categoriesgetGet a shortcut categorygetUpdate a shortcut categoryputDelete a shortcut categorydeleteShortcutsCreate a shortcutpostGet all shortcutsgetGet a shortcutgetUpdate a shortcutputDelete a shortcutdeleteSnippetsCreate snippetpostGet snippetsgetGet snippets by IDgetUpdate snippetputPatch snippetpatchSnoozesCreate a snoozepostGet all snoozesgetGet snooze by IDgetUpdate snooze by IDputDelete snoozedeleteApps PlatformAbout: Apps PlatformAppsGet Installed AppsgetGet Installed Apps (By Specific Version)getGet Available AppsgetGet Available AppgetCardsGet CardsgetGet CardgetUpdate a CardputDelete a CarddeleteCreate a CardpostInstall a CardpostHooks (Email Hooks)Create Email HookpostGet Email HooksgetGet an Email Hook by IDgetUpdate Email HookpatchGet Email Hook TransactionsgetHooks (Form Hooks)Create Form HookpostGet Form HooksgetGet a Form Hook by IDgetUpdate Form HookpatchCreate Form Hook TransactionpostGET Form Hook TransactionsgetCreate Form Hook Org TransactionpostHooks (Web Hooks)Create Web HookpostGet Web HooksgetGet a Web Hook by IDgetUpdate Web HookpatchCreate Web Hook TransactionpostGet Web Hook TransactionsgetKViews (Klass Views)Get KViewsgetGet KViews by ResourcegetUpdate KViews OrderputUpdate KViewputOutbound Web Hooks (Transactions)List TransactionsgetList Transactions For WebhookgetOutbound Web HooksList Outbound WebhooksgetCreate Outbound WebhookpostList Subscribable EventsgetGet Outbound WebhookgetUpdate Outbound WebhookpatchDelete Outbound WebhookdeleteAccess ManagementAbout: Access ManagementAuth SettingsGet Auth SettingsgetUpdate Auth SettingsputGet Auth Customer SettingsgetGet Public Auth SettingsgetAuth TokensCreate TokenpostGet Auth TokensgetGet Auth Token by IDgetDelete Auth Token by IDdeleteGet Current Auth TokengetDelete Current Auth TokendeleteRole GroupsGet Auth RolesgetCreate a Role GrouppostGet All Role GroupsgetGet A Role Group By IDgetUpdate a Role GroupputDelete a Role GroupdeleteTeamsCreate TeampostGet TeamsgetGet a User's TeamsgetUpdate Team AttributespatchAdd Team MemberpostRemove Team MemberdeleteTeams (By ID)Get Team by IDgetUpdate Team by IDputDelete TeamdeleteUsersCreate / Invite New UserpostGet UsersgetGet Current UsergetUpdate Current UserputReset User's PasswordpostUsers (By ID)Get User by IDgetUpdate User by IDputGet Multiple Users by IDsgetGet Auth Customer Settingsget https://api.kustomerapp.com/v1/auth/customer/settingsGets customer authentication settings, including a generated secret token. NOTE Requires org.admin privileges
