Authenticate requests using OAuth 2.0 tokens and the required scopes. Use conversations.readonly for reading data and conversations.write for creating or updating records. Store tokens securely, rotate them regularly, and follow least privilege access.
Authorize the Acronis app to access the Conversations API and grant the necessary scopes. Use the recommended OAuth flow or API key provisioning as configured in your GHL developer console.
GET /conversations/:conversationsId; GET /conversations/search; conversations.write; POST /conversations/; PUT /conversations/:conversationsId; DELETE /conversations/:conversationsId; conversations/message.readonly; GET conversations/messages/:messageId/locations/:locationId/recording; GET conversations/locations/:locationId/messages/:messageId/transcription; GET conversations/locations/:locationId/messages/:messageId/transcription/download; conversations/message.write; POST /conversations/messages; POST /conversations/messages/inbound; POST /conversations/messages/upload; PUT /conversations/messages/:messageId/status; DELETE /conversations/messages/:messageId/schedule; DELETE /conversations/messages/email/:emailMessageId/schedule
Trigger: GET /conversations/:conversationsId
Actions: retrieve full conversation details, including associated messages and metadata.
GET /conversations/:conversationsId
Key fields: conversationsId, status, participants, lastModified
Trigger: GET /conversations/search
Actions: filter by query terms, sort results, and paginate.
GET /conversations/search
Key fields: query, filters, sort, page, pageSize
Trigger: POST /conversations/ (and PUT /conversations/:conversationsId)
Actions: create new conversations and update existing ones; manage metadata and participants.
POST /conversations/ (and PUT /conversations/:conversationsId)
Key fields: payload, conversationsId, status, participants
Faster setup with ready to use endpoints and templates
Automates cross app workflows without custom development
Keeps data synchronized in real time across GHL and Acronis
Essential elements and processes you will encounter when integrating the GHL Conversations API with Acronis Cyber Protect Cloud.
Application Programming Interface: a defined set of rules that enables applications to communicate and share data.
The process of verifying identity and issuing access tokens before API calls are allowed.
A specific URL on the API that performs a function or returns data.
A callback URL that receives event notifications from the API when something happens.
Automatically create support tickets in your system when certain conversations reach a threshold or contain keywords.
Capture conversation activity and export to dashboards for compliance and performance reviews.
Deliver proactive self help messages and recovery tips to users through the integration.
Obtain OAuth tokens with the required scopes and securely store credentials.
Map the Conversations API endpoints to your workflows in Acronis and test calls.
Run tests, set up monitoring, and deploy automation in production.
The Conversations API is a versatile interface that lets your apps read, create, update, and manage conversations and messages within GHL. It provides programmatic access to conversations, messages, and associated metadata so you can automate workflows across tools. Use this API to fetch conversation threads, search for conversations, and push new messages into the system. It is designed to work with the Acronis Cyber Protect Cloud integration to streamline incident handling and customer communications.
Authentication is done using OAuth 2.0 tokens with scoped access. Your integration should request the appropriate scopes such as conversations.readonly for reading data and conversations.write for creating or updating data. Tokens should be stored securely, rotated regularly, and transmitted over HTTPS. If you need long lived access, implement refresh token handling per the OAuth flow guidelines.
Start with the core retrieval and creation endpoints. Fetch a conversation by ID, search for conversations, and create new conversations to establish the basic data flow. As you gain confidence, add endpoints to update status or manage messages. This phased approach helps validate permissions and data mappings before expanding to more advanced features.
Yes. You can schedule messages for future delivery or automation triggers. This is useful for follow ups, reminders, and compliance related communications. Ensure your app handles retries and respects rate limits to avoid failed deliveries.
Testing API calls is best done with a sandbox or staging environment. Use mock conversations and messages to validate authentication, data formats, and error handling. Verify responses against the expected schema and implement logging to diagnose failures quickly.
Rate limits vary by endpoint and plan. Plan for peak usage by implementing exponential backoff and retry logic. Monitor API usage with built in metrics and alert on unusual activity to prevent service disruption.
The complete list of endpoints is available in the Endpoint List section of this guide. You can also access the API reference in the developer console for up to date details on parameters, payloads, and response structures.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
