Authenticate requests using your Conversations API credentials. Use the provided API keys and ensure the correct scope (conversations.readonly for read access).
Create and securely store an API key or OAuth token from Acumbamail, grant necessary permissions, and test the connection in a staging environment before going live.
Key endpoints you may use include:\n- GET /conversations/:conversationsId (view a conversation)\n- GET /conversations/search (search conversations)\n- POST /conversations/ (create a conversation)\n- PUT /conversations/:conversationsId (update a conversation)\n- DELETE /conversations/:conversationsId (delete a conversation)\n- GET conversations/messages/:messageId/locations/:locationId/recording (fetch recording)\n- GET conversations/locations/:locationId/messages/:messageId/transcription (fetch transcription)\n- GET conversations/locations/:locationId/messages/:messageId/transcription/download (download transcription)\n- POST /conversations/messages (send a message)\n- POST /conversations/messages/inbound (handle inbound message)\n- POST /conversations/messages/upload (upload a message)\n- PUT /conversations/messages/:messageId/status (update status)\n- DELETE /conversations/messages/:messageId/schedule (cancel schedule)\n- DELETE /conversations/messages/email/:emailMessageId/schedule (cancel scheduled email)
Trigger: when a new conversation is created or a new inbound message arrives.
Actions: fetch details with GET /conversations/:conversationsId, then route or respond using messages endpoints to keep a seamless flow.
Methods to leverage: GET /conversations/:conversationsId and POST /conversations/messages to engage or reply.
Key fields: conversationsId, messageId, locationId
Trigger: audio or voice-enabled messages require transcription.
Actions: pull transcription with GET /conversations/locations/:locationId/messages/:messageId/transcription and use transcription/download as needed to enrich threads.
Methods: GET transcription endpoints to attach text context to conversations.
Key fields: locationId, messageId, transcriptionId
Trigger: inbound messages arrive and outbound replies are scheduled or triggered.
Actions: use POST /conversations/messages to send, and PUT /conversations/messages/:messageId/status or DELETE /conversations/messages/:messageId/schedule to manage flows.
Methods: POST /conversations/messages, PUT /conversations/messages/:messageId/status, DELETE /conversations/messages/:messageId/schedule.
Key fields: messageId, status, schedule
Automate conversations and workflows without writing code using visual builders and Zapier/app connectors.
Keep message history, transcripts, and location data synchronized to power richer campaigns.
Create end-to-end customer journeys with minimal setup and scalable automation.
This glossary covers endpoints, authentication methods, and data fields used to connect Acumbamail with the Conversations API.
A thread of messages between a contact and your team within Acumbamail via the Conversations API.
A URL path used by the API to perform a specific action, such as retrieving a conversation.
Text extracted from audio messages in a conversation.
Messages sent into your system from external sources.
Automatically tag conversations based on content and trigger targeted campaigns in Acumbamail.
Use transcripts to generate summaries and boost agent context for follow-ups.
Automate replies or follow-ups for inbound messages using endpoint data.
Collect API keys from both services and store them securely in your vault or CI/CD secret store.
Map fields, set triggers, and configure authentication in your automation tool or code.
Run end-to-end tests to verify data flow, then deploy to production with monitoring.
No heavy coding is required for basic setups when using no-code automation tools like Zapier or the app connector. For advanced use cases, light scripting can help tailor data flows. Start with standard endpoints to validate the connection, then expand.
Authentication typically uses API keys or OAuth tokens. Keep credentials secure, rotate keys periodically, and apply the minimum required scopes for your workflow.
For a basic sync, essential endpoints include GET /conversations/:conversationsId, GET /conversations/search, POST /conversations/, POST /conversations/messages, and relevant GET/PUT/DELETE for messages. Extend with transcription and recording endpoints as needed.
Yes. Use the scheduling endpoints such as DELETE /conversations/messages/:messageId/schedule to cancel or adjust outbound timing, and POST /conversations/messages to queue new messages.
Transcription data is accessible via GET /conversations/locations/:locationId/messages/:messageId/transcription and the download endpoint for offline processing. Attach transcripts to conversations to enrich context.
Common fields to map include conversationsId, messageId, locationId, and transcriptionId. Ensure consistent ID usage across systems and handle time zones correctly.
Rate limits depend on your plan and endpoints used. Plan for retries with exponential backoff and monitor quota in your integration dashboard.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
