Channel Automation API: endpoints 270–405
Conversations
Retrieve conversation history for contacts
- Get conversation history by phone numberGET
/api/conversations/phone - Resume AI responses for a workspace contactPOST
/api/ai/conversation-state/{contactId}/resume - Pause AI and cancel queued AI replies for a workspace contactPOST
/api/ai/conversation-state/{contactId}/takeover - Get all conversations within a date rangeGET
/api/conversations/recent - List today's appointments mapped to the signed-in repGET
/api/field-sales/appointments/today - List notes on one Sales Coach visitGET
/api/field-sales/appointments/{id}/notes - Add a note to one Sales Coach visitPOST
/api/field-sales/appointments/{id}/notes - List notes on one visit from the Sales Coach iPhone appGET
/api/field-sales/rep/appointments/{id}/notes - Add a visit note from the Sales Coach iPhone appPOST
/api/field-sales/rep/appointments/{id}/notes - Soft-delete a visit noteDEL
/api/field-sales/appointments/{id}/notes/{noteId} - Edit a visit notePATCH
/api/field-sales/appointments/{id}/notes/{noteId} - Soft-delete your own visit note from the iPhone appDEL
/api/field-sales/rep/appointments/{id}/notes/{noteId} - Edit your own visit note from the iPhone appPATCH
/api/field-sales/rep/appointments/{id}/notes/{noteId} - Judge the newest ~30 s of an in-progress visit against the sales processPOST
/api/field-sales/rep/live-steps - Record a rep-initiated device-location check-in for one assigned visitPOST
/api/field-sales/appointments/{id}/checkin - One location reading while a checked-in Sales Coach visit is openPOST
/api/field-sales/appointments/{id}/presence - The rep's reason for leaving a visit before the minimumPOST
/api/field-sales/appointments/{id}/leave-reason - Visits happening right now ("In the field"), for managersGET
/api/field-sales/visits/live - Suggest three short texts a manager could send the rep at this visitPOST
/api/field-sales/visits/{appointmentId}/message/suggest - Text the rep at this visit from the workspace numberPOST
/api/field-sales/visits/{appointmentId}/message - List Sales Coach visit assignments and latest check-ins for one contactGET
/api/field-sales/appointments/assignments - Explicitly map one assigned Sales Coach visit addressPOST
/api/field-sales/appointments/{id}/map-address - Erase one visit's location-derived check-in evidence, live step progress, coaching texts and mapped targetDEL
/api/field-sales/appointments/{id}/location-evidence - Assign or unassign a Sales Coach visitPUT
/api/field-sales/appointments/{id}/assignment - List visible field-sales conversationsGET
/api/field-sales/conversations - Register a field-sales recording uploadPOST
/api/field-sales/conversations - List only the signed-in rep's currently assigned visit reviewsGET
/api/field-sales/rep/conversations - Register an assigned visit recording with safe retriesPOST
/api/field-sales/rep/conversations - Verify an upload and queue conversation processingPOST
/api/field-sales/conversations/{id}/finalize - Finalize the rep's own actively assigned visit recordingPOST
/api/field-sales/rep/conversations/{id}/finalize - Queue an existing workspace call recording for Field Coach analysisPOST
/api/field-sales/existing-calls/analyze - Search contacts the caller may link to a recordingGET
/api/field-sales/contacts/search - Get transcript, analysis, and score for a conversationGET
/api/field-sales/conversations/{id} - Delete a conversation and queue erasure of its audio and analysisDEL
/api/field-sales/conversations/{id} - Get the signed-in rep's own visit review (native Sales Coach)GET
/api/field-sales/rep/conversations/{id} - Delete the rep's own currently assigned visit recordingDEL
/api/field-sales/rep/conversations/{id} - Create a short-lived private playback URLPOST
/api/field-sales/conversations/{id}/playback - Read the workspace scorecard and its version historyGET
/api/field-sales/scorecard - Publish a new scorecard versionPUT
/api/field-sales/scorecard - Read the workspace's Sales Coach arrival alert settingsGET
/api/field-sales/arrival-alert-settings - Save the workspace's Sales Coach arrival alert settingsPUT
/api/field-sales/arrival-alert-settings - Preview the arrival alert email with this workspace's name and logo and sample visit detailsGET
/api/field-sales/arrival-alert-settings/preview - Send a sample arrival alert to the signed-in user's own emailPOST
/api/field-sales/arrival-alert-settings/test - Read what the Sales Coach settings page shows about field readinessGET
/api/field-sales/settings/overview - Read the workspace's auto-analyze rulesGET
/api/field-sales/auto-analyze-settings - Save the workspace's auto-analyze rulesPUT
/api/field-sales/auto-analyze-settings - Mark a conversation for QA reviewPOST
/api/field-sales/conversations/{id}/qa-flag - List QA flags (the review queue)GET
/api/field-sales/qa-flags - Resolve a QA flag with a human verdictPOST
/api/field-sales/qa-flags/{id}/verdict - Rep acknowledges a coaching verdictPOST
/api/field-sales/qa-flags/{id}/acknowledge - List QA notes on a conversationGET
/api/field-sales/conversations/{id}/qa-notes - Add a QA note to a conversationPOST
/api/field-sales/conversations/{id}/qa-notes - Delete a QA noteDEL
/api/field-sales/conversations/{id}/qa-notes/{noteId} - Edit a QA notePATCH
/api/field-sales/conversations/{id}/qa-notes/{noteId} - Re-run transcription and analysis, publishing a new versionPOST
/api/field-sales/conversations/{id}/reprocess - Generate editable SMS and email follow-up draftsPOST
/api/field-sales/conversations/{id}/followup - Save a rep's edit of a follow-up draftPATCH
/api/field-sales/followups/{id} - Start an optional Allison Live voice sessionPOST
/api/openai/live/session
Sales Coach API
Read finished Sales Coach reviews (summary, scorecard, coaching, transcript) into an integration such as n8n. Requires a Sales Coach API key created by a workspace owner or admin.
Voice Lookup API
Facts a live voice agent needs about a matched contact: the qualification checklist on file and the last call summary. Information only, never instructions. Requires a workspace API key with contacts read.
Property Intelligence
Feature-flagged property data, valuation, and Street View previews
- Local-only property intelligence smoke testGET
/api/property-intelligence/internal/test-lookup - Local-only CEO demo brief for property intelligenceGET
/api/property-intelligence/internal/demo-brief - Local-only Street View image smoke testGET
/api/property-intelligence/internal/test-street-view-image - Preview property intelligence for an address or contactGET
/api/property-intelligence/lookup - Load CRM-ready property intelligence for a contactGET
/api/property-intelligence/demo-brief - Proxy a Google Street View image for an addressGET
/api/property-intelligence/street-view-image
RCS
RCS Business Messaging (Phase 1: text-only, additive to SMS). Platform-owner test endpoints.
- Get RCS configuration status for a workspace (platform owner only)GET
/api/rcs/workspaces/{workspaceId}/config - Get RCS configuration for self-serve setup (workspace admin)GET
/api/rcs/workspaces/{workspaceId}/client-config - Save RCS configuration self-serve (workspace admin)PUT
/api/rcs/workspaces/{workspaceId}/client-config - Send a test RCS message to a workspace's test device (workspace admin)POST
/api/rcs/workspaces/{workspaceId}/client-test-send - Send a test RCS text message (platform owner only)POST
/api/rcs/workspaces/{workspaceId}/test-send - Send an agent LiveChat text or media reply as RCSPOST
/api/rcs/workspaces/{workspaceId}/agent-send - List a workspace's stored RCS content templates (platform owner only)GET
/api/rcs/workspaces/{workspaceId}/templates - Register an RCS content template for a workspace (platform owner only)POST
/api/rcs/workspaces/{workspaceId}/templates - Send a test RICH RCS card (platform owner only)POST
/api/rcs/workspaces/{workspaceId}/test-send-card - List sendable RCS cards for the LiveChat composerGET
/api/rcs/workspaces/{workspaceId}/agent-templates - Send a saved RCS card from the LiveChat composer (Tier 2POST
/api/rcs/workspaces/{workspaceId}/agent-send-card - Create an RCS card from the builder (Tier 3POST
/api/rcs/workspaces/{workspaceId}/templates/create - Validate an RCS card payload without creating anything (Flow Builder V2)POST
/api/rcs/workspaces/{workspaceId}/templates/validate - Update a registered RCS card in place (Flow Builder V2 "Update card")PUT
/api/rcs/workspaces/{workspaceId}/templates/{templateId} - Delete a registered RCS card (Tier 3DEL
/api/rcs/workspaces/{workspaceId}/templates/{templateId}
Outbound IQ
Caller ID intelligence (no rollout flag). Settings, number sync, NRM, and today strip. Not the TwiML assignment path.
- Outbound IQ connection settingsGET
/api/outbound-iq/settings - Update Outbound IQ operator settingsPUT
/api/outbound-iq/settings - Test the universal key and sync campaign, dispositions, and numbersPOST
/api/outbound-iq/connect - Remove the stored Outbound IQ key and turn assignment offPOST
/api/outbound-iq/disconnect - Re-push active Twilio numbers to Outbound IQPOST
/api/outbound-iq/sync-now - Active workspace numbers joined with Outbound IQ reputation statsGET
/api/outbound-iq/numbers - Pause a number in Outbound IQ (cool-off)POST
/api/outbound-iq/numbers/{e164}/pause - Activate a paused number in Outbound IQPOST
/api/outbound-iq/numbers/{e164}/activate - Request carrier remediation for a numberPOST
/api/outbound-iq/numbers/{e164}/remediate - Run the Outbound IQ ANI PlannerPOST
/api/outbound-iq/planner - Today's caller-ID assignment vs fallback countsGET
/api/outbound-iq/today
AI
Notes AI Processor - Intelligent content operations (Cloudflare Worker)
AgentTeams
Condition-based agent teams for routing inbound contacts
- List all agent teams for a workspaceGET
/api/agent-teams/workspace/{workspaceId} - Create a new agent team with members and rulePOST
/api/agent-teams/workspace/{workspaceId} - Update a team's metadata, members, and/or rulePUT
/api/agent-teams/{teamId} - Delete a team (cascades to rule, members, tracker)DEL
/api/agent-teams/{teamId} - Bulk update team priorities (drag-to-reorder)PUT
/api/agent-teams/workspace/{workspaceId}/reorder - Dry-run — given a contact (or contact id), return which team would matchPOST
/api/agent-teams/workspace/{workspaceId}/preview
Platform Admin
- MCP staff key management bundle (Command Center)GET
/api/admin/mcp-permissions - Create an MCP staff key (value shown once)POST
/api/admin/mcp-permissions/keys - Update an MCP staff key (only the fields sent)PATCH
/api/admin/mcp-permissions/keys/{keyId} - Rotate an MCP staff key (new value shown once)POST
/api/admin/mcp-permissions/keys/{keyId}/rotate - List customer AI connector permissions for every workspaceGET
/api/admin/mcp-access - Set customer AI connector permissions for one workspacePUT
/api/admin/mcp-access/{workspaceId}
AI Connectors
- AI connector access for this workspaceGET
/api/workspaces/{workspaceId}/ai-connectors/access - Choose which roles may use AI connectorsPUT
/api/workspaces/{workspaceId}/ai-connectors/access - List AI connector integration keysGET
/api/workspaces/{workspaceId}/ai-connectors/integration-keys - Create an AI connector integration key (value shown once)POST
/api/workspaces/{workspaceId}/ai-connectors/integration-keys - Revoke an AI connector integration keyDEL
/api/workspaces/{workspaceId}/ai-connectors/integration-keys/{keyId} - List connected AI apps (OAuth grants)GET
/api/workspaces/{workspaceId}/ai-connectors/grants - Disconnect a connected AI appDEL
/api/workspaces/{workspaceId}/ai-connectors/grants/{grantId} - AI connector activity in this workspaceGET
/api/workspaces/{workspaceId}/ai-connectors/activity
Billing
- Get complete billing information for workspaceGET
/api/billing/workspace/{workspaceId} - Create Stripe checkout session for plan upgradePOST
/api/billing/checkout - Cancel workspace subscriptionPOST
/api/billing/subscription/cancel - Reactivate canceled subscriptionPOST
/api/billing/subscription/reactivate - Get current usage statisticsGET
/api/billing/usage/{workspaceId} - Get billing history/invoicesGET
/api/billing/history/{workspaceId} - Create setup intent for payment method collectionPOST
/api/billing/payment-method/setup - Update workspace payment methodPOST
/api/billing/payment-method/update - Update billing informationPOST
/api/billing/update-info - Create Stripe customer portal sessionGET
/api/billing/portal/{workspaceId}
Call Queues
Calls
ErrorLogs
- List error logs for a workspaceGET
/api/workspaces/{workspaceId}/error-logs - Get error log statisticsGET
/api/workspaces/{workspaceId}/error-logs/stats - Mark an error log as resolvedPATCH
/api/workspaces/{workspaceId}/error-logs/{id}/resolve - Delete an error log entryDEL
/api/workspaces/{workspaceId}/error-logs/{id} - Bulk resolve all unresolved error logsPOST
/api/workspaces/{workspaceId}/error-logs/resolve-all
