How to get manual templates
This document is designed to help you understand how you can fetch a list of all the manual templates owned by a dealership. To get this data, you first need your credentials. If you don't already have one, head over to the Authentication and Authorization page to see how you can request for credentials from us.
The endpoint mentioned below can be used to get the list of all the manual templates for a dealership -
Request
HTTP request
GET https://api.mykaarma.com/manage/v2/dealer//manualTemplatesParameters
| Parameter Name | Value | Description |
|---|---|---|
ServiceSubscriberDealer | string | Unique identifier (UUID) of the dealership for which you want to create manual templates |
Authorization
This request requires following scopes
| Scope | Level | Description |
|---|---|---|
manage.dealer.read | Dealer | Authorizes client to get manual templates for given dealership |
Curl
curl -X GET "https://api.mykaarma.com/manage/v2/dealer/{{dealerUuid}}/manualTemplates"
--header 'accept: application/json' \
-u "{{username}}:{{password}}" \
--header 'Content-Type: application/json'
Response
{
"apiRequestId": "string",
"errors": [
{
"errorCode": "number",
"errorMessage": "string",
"errorTitle": "string"
}
],
"templates": [
{
"template": "string",
"title": "string",
"uuid": "string"
}
],
"warnings": [
{
"warningCode": "number",
"warningMessage": "string",
"warningTitle": "string"
}
]
}
{templates} - List containing details of all the manual templates.
Sample Response
{
"errors": [],
"warnings": [],
"apiRequestId": "c984ae02-6bd4-46b4-a323-2f5c78faf64e",
"templates": [
{
"title": "1. Welcome",
"template": "Please store this number as a contact in your mobile phone as _DealerName . Any call or text to this number gives you direct access to me and my team for all of your service needs. Send STOP to cancel any further texts. _c_mms_vcard",
"uuid": "97b6cdf38e0d873607b2dba5c9357b73781dfbed788cd77c3c1e56ebaf882247"
},
{
"title": "2. Waiter",
"template": "_fname - While you wait, connect to our free Wi-Fi & enjoy complimentary refreshments.",
"uuid": "27137bdfc75d0dd012d507289ecbdcce73f2d42ccddaa253f56672ce38006245"
},
{
"title": "3. Green MPI",
"template": "Congratulations _fname! Your Multi Point Inspection is complete. No service needs at this time. Great job!",
"uuid": "5f4ae4f1fd28fa2663b19e40870c2d75e416a37ef14d57faad44779be5fbb758"
},
{
"title": "4. Call Back",
"template": "_fname, when convenient, please call me at this number regarding your vehicle.",
"uuid": "b927fd37d60910af4366a6f04b8ff48b376eae8d94b79bb1b04c51df57ce97be"
},
{
"title": "5. No Answer. No Reply.",
"template": "Dear _fname, I am trying to contact you. Please call me at this number to discuss your vehicle.",
"uuid": "2e4cbabff8da17c7f0ef9ed22672413eee9ca26572c97d2bc54d72f3c85860e7"
},
{
"title": "6. Car Ready (Waiter)",
"template": "Good News _fname! Your vehicle is ready.",
"uuid": "01ae43c50f6a1dba922afd5db5c09ca2bcc8fb493d33f5881bd2951f7ac58621"
},
{
"title": "8. Car Ready w/$ (offsite)",
"template": "_fname, your service is complete. Let me know your pick-up time and I'll have your vehicle ready. Repair total = $",
"uuid": "c3aa00c418248d6b000d55dfba4e516f53c688272c11efec00f9ce58b5cef806"
},
{
"title": "9. Shuttle on the way",
"template": "_fname, Your shuttle is on its way.",
"uuid": "f8be685336154cd9c2329e8afdeaa7a8a9d106fe4f3cb8892fd131acbef538ee"
},
{
"title": "10. Follow Up",
"template": "_fname - Thank you for trusting us with the service of your vehicle. If you have any further questions or concerns, please don't hesitate to text or call me at this number.",
"uuid": "af5dac1bd310cbf4e0227c093d43fa8b0d21b4352ea21e3677191b96047d059c"
},
{
"title": "1. Welcome Text",
"template": "Dear _fname, thank you for texting. How may I assist you? Please save this number as _DealerName for convenient communication and rapid responses.",
"uuid": "faf7509a52b2f2deb80bf66ffded7713b769befa940afa9c04b4a073c83855fc"
},
{
"title": "2. Inquiry Response",
"template": "Dear _fname, thank you for contacting us. Would you like me to call you or continue via text? I want to communicate with you based on your preference. Please save this number as _DealerName for convenient communication and rapid responses.",
"uuid": "6064a30472002e2db298739b3c61d42e1fd18f64a22d9fc06929cc5850818721"
},
{
"title": "3. Car Details",
"template": "Dear _fname, please view this URL for the vehicle details:",
"uuid": "c6f7a8f8288dc0704e7ba00889e213c2a4de136cb68efbccc8f577401ce65eba"
},
{
"title": "4. Test Drive",
"template": "I would like to schedule a VIP Test Drive -- more than just around the block! What day and time would work best?",
"uuid": "9e86aee6f50d1646014f3942e9366004a47944488b34b71f1aa12bbb88ae9abc"
},
{
"title": "5. Invite Into the Dealership",
"template": "It would be my pleasure to schedule an appointment with you. When are you available this week?",
"uuid": "c89e7639240f9fa26be478441f6606074734cf4608a0710485df1ab67e9b97aa"
},
{
"title": "6. Satisfaction Follow Up",
"template": "Just checking in. Do you have any questions or outstanding items that I can assist with?",
"uuid": "d4f7d97e1f70db2b9ddf851d86d690bd75512a4fcd1e2cd3fc76c98ba808538e"
},
{
"title": "7. Follow-Up",
"template": "Dear _fname, it’d be my pleasure to assist you if you are still in the market for a vehicle. Please do not hesitate to text or call me on this number with any questions. Thank you for the opportunity for your business.",
"uuid": "01cedc7da28d5996f87487a5decbea797ffebcd161b812b3684a49c03cae5d6f"
},
{
"title": "Loaner Charges",
"template": "_fname you have sustained charges based on your recent loaner vehicle usage. We will be sending a bill through an online payment link. Please let me know if you have any questions.",
"uuid": "215affea837b917d60771393e8bc0db8cbe71d84039c7ea4beee219c1ce0c84a"
},
{
"title": "Loaner Car Damages",
"template": "_fname you have sustained damages to your loaner vehicle during your recent service visit. We will be sending a bill through an online payment link. Please let me know if you have any questions.",
"uuid": "1742ae44ed1f810b0a97f578ff59d72d8b6973929763239bd709320edba9fab1"
}
]
}