Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.hoopai.com/llms.txt

Use this file to discover all available pages before exploring further.

The Conversations API gives programmatic access to the messaging layer of the HoopAI Platform. Use it to create conversations, send outbound messages across SMS, email, WhatsApp, Facebook, Instagram, and live chat channels, retrieve full message history, handle inbound message ingestion, upload file attachments, cancel scheduled messages, and retrieve call recordings and transcriptions. It supports both automation-driven messaging and real-time live chat integrations.

​
Base URL

https://services.leadconnectorhq.com

​
Authentication

All endpoints require a Bearer token and an API version header. 
Authorization: Bearer <access_token>
Version: 2021-07-28
See OAuth 2.0 to obtain an access token.

​
OAuth scopes

ScopeAccess
conversations.readonlyRead conversations
conversations.writeCreate, update, and delete conversations
conversations/message.readonlyRead messages within conversations
conversations/message.writeSend messages and upload attachments
conversations/livechat.writeSend live chat typing indicators

​
Quick start

Send a new outbound SMS message: 
curl -X POST https://services.leadconnectorhq.com/conversations/messages \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "SMS",
    "conversationId": "ABCHkzuJQ8ZMd4Te84GK",
    "message": "Hello, your appointment is confirmed for tomorrow at 10am."
  }'

​
Endpoints

MethodPathDescription
POST/conversations/Create conversation
GET/conversations/searchSearch conversations
GET/conversations/{conversationId}Get conversation
PUT/conversations/{conversationId}Update conversation
DELETE/conversations/{conversationId}Delete conversation
GET/conversations/{conversationId}/messagesGet messages by conversation ID
POST/conversations/messagesSend a new message
POST/conversations/messages/inboundAdd an inbound message
POST/conversations/messages/outboundAdd an external outbound call
POST/conversations/messages/uploadUpload file attachments
GET/conversations/messages/{id}Get message by message ID
PUT/conversations/messages/{messageId}/statusUpdate message status
DELETE/conversations/messages/{messageId}/scheduleCancel a scheduled message
GET/conversations/messages/email/{id}Get email by ID
DELETE/conversations/messages/email/{emailMessageId}/scheduleCancel a scheduled email message
GET/conversations/messages/{messageId}/locations/{locationId}/recordingGet recording by message ID
GET/conversations/locations/{locationId}/messages/{messageId}/transcriptionGet transcription by message ID
GET/conversations/locations/{locationId}/messages/{messageId}/transcription/downloadDownload transcription by message ID
POST/conversations/providers/live-chat/typingSend live chat typing indicator
  • Contacts API — Retrieve the contact associated with a conversation
  • Calendars API — Book appointments and send confirmation messages
  • Workflows API — Trigger automated messaging sequences
Last modified on March 5, 2026