Communication API
A comprehensive guide to send text/email to dealership customer on behalf of dealership advisor using myKaarma Communication API's.
📄️ How to send a text or email to customer
This endpoint allows you to send both text messages and emails to customers. The same API endpoint is used for both communication types - you simply change the protocol field and provide the appropriate contact information.
📄️ How to call a customer
This endpoint allows you to initiate an outbound voice call between a dealership user and a customer.
📄️ How to post an internal note for a customer
This endpoint allows you to post an internal note within a customer conversation. These notes are not visible to the end customer; they are only shown within the customer conversation in myKaarma. There's also a functionality to tag users or user groups to notify them, but that is out of scope of this documentation at the moment.
📄️ How to send a system notification with notifier pop
This endpoint allows you to post a system notification within a customer conversation and pop the myKaarma notifier for dealership users. System notifications are not sent to the end customer; they are only shown within the customer conversation in myKaarma. Unlike an internal note, a system notification is created automatically by a system (isManual: false) rather than by a user.
📄️ How to get conversations for a customer
To get customer conversations, you first need your credentials. If you don't already have one, head over to the page to see how you can request for credentials from us.