API Reference The CustomerHero API lets you programmatically manage chatbots, customers, conversations, and more. All endpoints return JSON responses.
Manage your chatbots — create, list, update, and delete.
GET /api/orgs/{orgId}/chatbotsPOST /api/orgs/{orgId}/chatbotsGET /api/orgs/{orgId}/chatbots/{chatbotId}PUT /api/orgs/{orgId}/chatbots/{chatbotId}DELETE /api/orgs/{orgId}/chatbots/{chatbotId}List, view, and update conversations. Manage tags and timeline.
GET /api/orgs/{orgId}/conversationsPOST /api/orgs/{orgId}/conversationsGET /api/orgs/{orgId}/conversations/{conversationId}PATCH /api/orgs/{orgId}/conversations/{conversationId}POST /api/orgs/{orgId}/conversations/{conversationId}/messagesPOST /api/orgs/{orgId}/conversations/{conversationId}/notesGET /api/orgs/{orgId}/conversations/{conversationId}/tagsPOST /api/orgs/{orgId}/conversations/{conversationId}/tagsDELETE /api/orgs/{orgId}/conversations/{conversationId}/tags/{tagId}GET /api/orgs/{orgId}/conversations/{conversationId}/timelinePOST /api/orgs/{orgId}/conversations/{conversationId}/readPOST /api/orgs/{orgId}/conversations/{conversationId}/draftsDELETE /api/orgs/{orgId}/conversations/{conversationId}/draftsPOST /api/orgs/{orgId}/conversations/{conversationId}/ai/categorizePOST /api/orgs/{orgId}/conversations/{conversationId}/ai/draftPOST /api/orgs/{orgId}/conversations/{conversationId}/ai/summarizePOST /api/orgs/{orgId}/conversations/{conversationId}/ai/tonePATCH /api/orgs/{orgId}/conversations/bulkPOST /api/orgs/{orgId}/conversations/mark-unreadGET /api/orgs/{orgId}/conversations/{conversationId}/adjacentGET /api/orgs/{orgId}/conversations/{conversationId}/customer-dataPOST /api/orgs/{orgId}/conversations/{conversationId}/messages/{messageId}/attachmentsPOST /api/orgs/{orgId}/conversations/{conversationId}/messages/{messageId}/retryPOST /api/orgs/{orgId}/conversations/{conversationId}/messages/{messageId}/reactionsDELETE /api/orgs/{orgId}/conversations/{conversationId}/messages/{messageId}/reactionsPOST /api/orgs/{orgId}/conversations/{conversationId}/messages/readPOST /api/orgs/{orgId}/conversations/{conversationId}/typingPOST /api/orgs/{orgId}/conversations/{conversationId}/messages/{messageId}/translatePOST /api/orgs/{orgId}/conversations/{conversationId}/snoozeDELETE /api/orgs/{orgId}/conversations/{conversationId}/snoozePOST /api/orgs/{orgId}/conversations/{conversationId}/mergePOST /api/orgs/{orgId}/conversations/{conversationId}/merge/undoGET /api/orgs/{orgId}/conversations/{conversationId}/merge-candidatesPOST /api/orgs/{orgId}/conversations/{conversationId}/splitGET /api/orgs/{orgId}/conversations/{conversationId}/split-previewPOST /api/orgs/{orgId}/conversations/{conversationId}/resume-botGET /api/orgs/{orgId}/conversations/{conversationId}/kb-suggestionsPOST /api/orgs/{orgId}/conversations/{conversationId}/macros/{macroId}/runGET /api/orgs/{orgId}/conversations/{conversationId}/slaGET /api/orgs/{orgId}/conversations/{conversationId}/bookingsGET /api/orgs/{orgId}/conversations/{conversationId}/hubspot-dataPOST /api/orgs/{orgId}/conversations/{conversationId}/hubspot-ticketGET /api/orgs/{orgId}/conversations/{conversationId}/stripe-connect-dataGET /api/orgs/{orgId}/conversations/{conversationId}/transcript.pdfGET /api/orgs/{orgId}/conversations/{conversationId}/transcript.jsonManage customer profiles — list, create, update, merge, and delete.
GET /api/orgs/{orgId}/customersPOST /api/orgs/{orgId}/customersGET /api/orgs/{orgId}/customers/{customerId}PUT /api/orgs/{orgId}/customers/{customerId}DELETE /api/orgs/{orgId}/customers/{customerId}GET /api/orgs/{orgId}/customers/{customerId}/propertiesPUT /api/orgs/{orgId}/customers/{customerId}/propertiesPOST /api/orgs/{orgId}/customers/mergePOST /api/orgs/{orgId}/customers/{customerId}/dsrManage company profiles and their contacts.
GET /api/orgs/{orgId}/companiesPOST /api/orgs/{orgId}/companiesGET /api/orgs/{orgId}/companies/{companyId}PUT /api/orgs/{orgId}/companies/{companyId}DELETE /api/orgs/{orgId}/companies/{companyId}GET /api/orgs/{orgId}/companies/{companyId}/customersAdd and manage training data for chatbots — URLs, text, Q&A, and files.
POST /api/orgs/{orgId}/chatbots/{chatbotId}/data-sourcesGET /api/orgs/{orgId}/chatbots/{chatbotId}/data-sourcesPATCH /api/orgs/{orgId}/chatbots/{chatbotId}/data-sources/{id}DELETE /api/orgs/{orgId}/chatbots/{chatbotId}/data-sources/{id}GET /api/orgs/{orgId}/chatbots/{chatbotId}/data-sources/{dataSourceId}/jobsGET /api/orgs/{orgId}/chatbots/{chatbotId}/data-sources/{dataSourceId}/jobs/{jobId}/pagesGET /api/orgs/{orgId}/chatbots/{chatbotId}/data-sources/{id}/detailPOST /api/orgs/{orgId}/chatbots/{chatbotId}/data-sources/{id}/refreshConfigure messaging channels — widget, WhatsApp, email, and more.
GET /api/orgs/{orgId}/chatbots/{chatbotId}/channelsPOST /api/orgs/{orgId}/chatbots/{chatbotId}/channelsDELETE /api/orgs/{orgId}/chatbots/{chatbotId}/channelsPOST /api/orgs/{orgId}/chatbots/{chatbotId}/channels/testPOST /api/orgs/{orgId}/chatbots/{chatbotId}/channels/reregisterManage reusable response templates.
GET /api/orgs/{orgId}/canned-responsesPOST /api/orgs/{orgId}/canned-responsesPUT /api/orgs/{orgId}/canned-responses/{id}DELETE /api/orgs/{orgId}/canned-responses/{id}Manage API keys for programmatic access.
GET /api/orgs/{orgId}/api-keysPOST /api/orgs/{orgId}/api-keysPATCH /api/orgs/{orgId}/api-keys/{id}DELETE /api/orgs/{orgId}/api-keys/{id}Manage team members and invitations.
GET /api/orgs/{orgId}/teamPOST /api/orgs/{orgId}/teamPUT /api/orgs/{orgId}/team/{memberId}DELETE /api/orgs/{orgId}/team/{memberId}DELETE /api/orgs/{orgId}/team/invitations/{invitationId}
POST /api/orgs/{orgId}/chatbots/{chatbotId}/avatarDELETE /api/orgs/{orgId}/chatbots/{chatbotId}/avatar
POST /api/orgs/{orgId}/chatbots/{chatbotId}/test-customer-data-endpoint
GET /api/orgs/{orgId}/chatbots/{chatbotId}/analytics/answer-qualityGET /api/orgs/{orgId}/analyticsGET /api/orgs/{orgId}/analytics/deflectionGET /api/orgs/{orgId}/analytics/unansweredPOST /api/orgs/{orgId}/analytics/unanswered/{id}/statusPOST /api/orgs/{orgId}/analytics/unanswered/{id}/add-to-knowledgeGET /api/orgs/{orgId}/analytics/topicsGET /api/orgs/{orgId}/analytics/anomaliesPOST /api/orgs/{orgId}/analytics/rollups/backfillGET /api/orgs/{orgId}/analytics/workflows
GET /api/orgs/{orgId}/conversation-statusesPOST /api/orgs/{orgId}/conversation-statusesPATCH /api/orgs/{orgId}/conversation-statuses/{id}DELETE /api/orgs/{orgId}/conversation-statuses/{id}
GET /api/orgs/{orgId}/customer-propertiesPOST /api/orgs/{orgId}/customer-propertiesPUT /api/orgs/{orgId}/customer-properties/{propertyId}DELETE /api/orgs/{orgId}/customer-properties/{propertyId}
GET /api/orgs/{orgId}/macrosPOST /api/orgs/{orgId}/macrosPUT /api/orgs/{orgId}/macros/{id}DELETE /api/orgs/{orgId}/macros/{id}GET /api/orgs/{orgId}/macros/exportPOST /api/orgs/{orgId}/macros/importPOST /api/orgs/{orgId}/macros/starter-pack
POST /api/orgs/{orgId}/macro-runs/{runId}/undo
GET /api/orgs/{orgId}/agents
GET /api/orgs/{orgId}/inbox-teamsPOST /api/orgs/{orgId}/inbox-teamsGET /api/orgs/{orgId}/inbox-teams/{teamId}PATCH /api/orgs/{orgId}/inbox-teams/{teamId}DELETE /api/orgs/{orgId}/inbox-teams/{teamId}POST /api/orgs/{orgId}/inbox-teams/{teamId}/membersPATCH /api/orgs/{orgId}/inbox-teams/{teamId}/members/{userId}DELETE /api/orgs/{orgId}/inbox-teams/{teamId}/members/{userId}
POST /api/orgs/{orgId}/logoDELETE /api/orgs/{orgId}/logo
GET /api/orgs/{orgId}/billingPATCH /api/orgs/{orgId}/billing/credit-settingsGET /api/orgs/{orgId}/billing/creditsPOST /api/orgs/{orgId}/billing/credits/top-upPOST /api/orgs/{orgId}/billing/checkoutPOST /api/orgs/{orgId}/billing/portal
GET /api/orgs/{orgId}/saved-searchesPOST /api/orgs/{orgId}/saved-searchesPATCH /api/orgs/{orgId}/saved-searches/{id}DELETE /api/orgs/{orgId}/saved-searches/{id}
GET /api/orgs/{orgId}/chatbots/{chatbotId}/actionsPOST /api/orgs/{orgId}/chatbots/{chatbotId}/actionsGET /api/orgs/{orgId}/chatbots/{chatbotId}/actions/{actionId}PUT /api/orgs/{orgId}/chatbots/{chatbotId}/actions/{actionId}DELETE /api/orgs/{orgId}/chatbots/{chatbotId}/actions/{actionId}PUT /api/orgs/{orgId}/chatbots/{chatbotId}/actions/reorder
GET /api/orgs/{orgId}/chatbots/{chatbotId}/workflowsPOST /api/orgs/{orgId}/chatbots/{chatbotId}/workflowsGET /api/orgs/{orgId}/chatbots/{chatbotId}/workflows/{workflowId}PUT /api/orgs/{orgId}/chatbots/{chatbotId}/workflows/{workflowId}DELETE /api/orgs/{orgId}/chatbots/{chatbotId}/workflows/{workflowId}PUT /api/orgs/{orgId}/chatbots/{chatbotId}/workflows/reorder
GET /api/orgs/{orgId}/chatbots/{chatbotId}/triggersPOST /api/orgs/{orgId}/chatbots/{chatbotId}/triggersGET /api/orgs/{orgId}/chatbots/{chatbotId}/triggers/{triggerId}PATCH /api/orgs/{orgId}/chatbots/{chatbotId}/triggers/{triggerId}DELETE /api/orgs/{orgId}/chatbots/{chatbotId}/triggers/{triggerId}GET /api/orgs/{orgId}/chatbots/{chatbotId}/triggers/analytics
GET /api/orgs/{orgId}/notification-settingsPUT /api/orgs/{orgId}/notification-settings
GET /api/orgs/{orgId}/stale-conversation-notificationsPATCH /api/orgs/{orgId}/stale-conversation-notifications
GET /api/orgs/{orgId}/routing-rulesPOST /api/orgs/{orgId}/routing-rulesPUT /api/orgs/{orgId}/routing-rules/{id}DELETE /api/orgs/{orgId}/routing-rules/{id}GET /api/orgs/{orgId}/routing-rules/auditPOST /api/orgs/{orgId}/routing-rules/testPOST /api/orgs/{orgId}/routing-rules/reorder
GET /api/orgs/{orgId}/reports/agent-performanceGET /api/orgs/{orgId}/reports/team-performanceGET /api/orgs/{orgId}/reports/sla-complianceGET /api/orgs/{orgId}/reports/backlog-ageGET /api/orgs/{orgId}/reports/reopen-rateGET /api/orgs/{orgId}/reports/handoff-funnelGET /api/orgs/{orgId}/reports/channel-mix
GET /api/orgs/{orgId}/analytics-targetsPATCH /api/orgs/{orgId}/analytics-targets
GET /api/orgs/{orgId}/mentionsGET /api/orgs/{orgId}/mentions/unread-countPOST /api/orgs/{orgId}/mentions/{id}/readPOST /api/orgs/{orgId}/mentions/read-all
GET /api/orgs/{orgId}/dsr/{dsrId}DELETE /api/orgs/{orgId}/dsr/{dsrId}POST /api/orgs/{orgId}/dsr/{dsrId}/confirm
GET /api/orgs/{orgId}/chatbots/{chatbotId}/privacyPUT /api/orgs/{orgId}/chatbots/{chatbotId}/privacyPOST /api/orgs/{orgId}/chatbots/{chatbotId}/privacy/redaction-preview
GET /api/orgs/{orgId}/retentionPUT /api/orgs/{orgId}/retention
GET /api/orgs/{orgId}/sla-policiesPOST /api/orgs/{orgId}/sla-policiesPATCH /api/orgs/{orgId}/sla-policies/{id}DELETE /api/orgs/{orgId}/sla-policies/{id}
GET /api/orgs/{orgId}/webhook-subscriptionsPOST /api/orgs/{orgId}/webhook-subscriptionsGET /api/orgs/{orgId}/webhook-subscriptions/{id}PATCH /api/orgs/{orgId}/webhook-subscriptions/{id}DELETE /api/orgs/{orgId}/webhook-subscriptions/{id}POST /api/orgs/{orgId}/webhook-subscriptions/{id}/rotate-secretGET /api/orgs/{orgId}/webhook-subscriptions/{id}/deliveriesPOST /api/orgs/{orgId}/webhook-subscriptions/{subId}/deliveries/{deliveryId}/replay
GET /api/orgs/{orgId}/webhook-event-types
GET /api/orgs/{orgId}/audit-logGET /api/orgs/{orgId}/audit-log/export
GET /api/orgs/{orgId}/abuse/eventsPOST /api/orgs/{orgId}/abuse/bansDELETE /api/orgs/{orgId}/abuse/bans/{ruleId}GET /api/orgs/{orgId}/abuse/rulesPOST /api/orgs/{orgId}/abuse/rulesPATCH /api/orgs/{orgId}/abuse/rules/{ruleId}DELETE /api/orgs/{orgId}/abuse/rules/{ruleId}
GET /api/orgs/{orgId}/sso-connectionsPOST /api/orgs/{orgId}/sso-connectionsPATCH /api/orgs/{orgId}/sso-connections/{id}DELETE /api/orgs/{orgId}/sso-connections/{id}GET /api/orgs/{orgId}/sso-connections/{id}/metadataPublic
GET /api/orgs/{orgId}/network/ip-allowlistPUT /api/orgs/{orgId}/network/ip-allowlistGET /api/orgs/{orgId}/network/emergency-credential
GET /api/orgs/{orgId}/scim-tokensPOST /api/orgs/{orgId}/scim-tokensDELETE /api/orgs/{orgId}/scim-tokens/{id}
GET /api/orgs/{orgId}/chatbots/{chatbotId}/calendarPUT /api/orgs/{orgId}/chatbots/{chatbotId}/calendarDELETE /api/orgs/{orgId}/chatbots/{chatbotId}/calendarGET /api/orgs/{orgId}/chatbots/{chatbotId}/calendar/event-types
GET /api/orgs/{orgId}/integrationsGET /api/orgs/{orgId}/integrations/{provider}/installDELETE /api/orgs/{orgId}/integrations/{provider}GET /api/orgs/{orgId}/integrations/slack/channelsPATCH /api/orgs/{orgId}/integrations/slack/config
GET /api/orgs/{orgId}/help-sitesPOST /api/orgs/{orgId}/help-sitesGET /api/orgs/{orgId}/help-sites/{siteId}PATCH /api/orgs/{orgId}/help-sites/{siteId}DELETE /api/orgs/{orgId}/help-sites/{siteId}GET /api/orgs/{orgId}/help-sites/{siteId}/collectionsPOST /api/orgs/{orgId}/help-sites/{siteId}/collectionsPATCH /api/orgs/{orgId}/help-sites/{siteId}/collections/{collectionId}DELETE /api/orgs/{orgId}/help-sites/{siteId}/collections/{collectionId}POST /api/orgs/{orgId}/help-sites/{siteId}/collections/reorderGET /api/orgs/{orgId}/help-sites/{siteId}/articlesPOST /api/orgs/{orgId}/help-sites/{siteId}/articlesPOST /api/orgs/{orgId}/help-sites/{siteId}/articles/reorderGET /api/orgs/{orgId}/help-sites/{siteId}/articles/{articleId}PATCH /api/orgs/{orgId}/help-sites/{siteId}/articles/{articleId}DELETE /api/orgs/{orgId}/help-sites/{siteId}/articles/{articleId}POST /api/orgs/{orgId}/help-sites/{siteId}/articles/{articleId}/restoreDELETE /api/orgs/{orgId}/help-sites/{siteId}/articles/{articleId}/permanentGET /api/orgs/{orgId}/help-sites/{siteId}/assetsPOST /api/orgs/{orgId}/help-sites/{siteId}/assetsPATCH /api/orgs/{orgId}/help-sites/{siteId}/assets/{assetId}DELETE /api/orgs/{orgId}/help-sites/{siteId}/assets/{assetId}GET /api/orgs/{orgId}/help-sites/{siteId}/assets/{assetId}/usageGET /api/orgs/{orgId}/help-sites/{siteId}/articles/{articleId}/public-urlPOST /api/orgs/{orgId}/help-sites/{siteId}/articles/{articleId}/preview-tokenGET /api/orgs/{orgId}/help-sites/{siteId}/articles/{articleId}/backlinksGET /api/orgs/{orgId}/help-sites/{siteId}/articles/{articleId}/revisionsGET /api/orgs/{orgId}/help-sites/{siteId}/articles/{articleId}/revisions/{revisionId}POST /api/orgs/{orgId}/help-sites/{siteId}/articles/{articleId}/revisions/{revisionId}/restorePOST /api/orgs/{orgId}/help-sites/{siteId}/articles/ai/draftPOST /api/orgs/{orgId}/help-sites/{siteId}/articles/{articleId}/ai/rewritePOST /api/orgs/{orgId}/help-sites/{siteId}/articles/{articleId}/ai/translateGET /api/orgs/{orgId}/help-sites/{siteId}/suggestions/countGET /api/orgs/{orgId}/help-sites/{siteId}/suggestionsPATCH /api/orgs/{orgId}/help-sites/{siteId}/suggestions/{suggestionId}GET /api/orgs/{orgId}/help-sites/{siteId}/analytics
GET /api/orgs/{orgId}/chatbots/{chatbotId}/identity-secretsPOST /api/orgs/{orgId}/chatbots/{chatbotId}/identity-secretsDELETE /api/orgs/{orgId}/chatbots/{chatbotId}/identity-secrets/{secretId}
GET /api/orgs/{orgId}/chatbots/{chatbotId}/identity-stats
GET /api/orgs/{orgId}/verified-domainsPOST /api/orgs/{orgId}/verified-domainsPOST /api/orgs/{orgId}/verified-domains/{id}/verifyDELETE /api/orgs/{orgId}/verified-domains/{id}