How to create a follow up task type

This endpoint allows you to create a new follow-up task type for a dealer. Task types define the categories of follow-up tasks (e.g., "Declined Service", "No Show", "Missed Appointment").

To use this endpoint, you first need your credentials. If you don't already have one, please head over to the Authentication and Authorization page to see how you can request for credentials from us.

Request

HTTP request

POST  https://api.mykaarma.com/leads/followup/dealer/{dealerUUID}/task-type

Parameters

Required path parameters:

Parameter Name	Value	Description
dealerUUID	string	Unique identifier for the dealer for which the follow up task type needs to be created

Authorization

This request requires authorization. Include your credentials in the authorization header.

Request Body

Property Name	Type	Description
taskName	string	Name of the task type
taskDisplayName	string	Name to be displayed on the app
taskDescription	string	Description of the task type

Sample Request

curl --location 'https://api.mykaarma.com/leads/followup/dealer/{dealerUUID}/task-type' \
--header 'accept: application/json' \
--header 'authorization: <your-credentials>' \
--header 'Content-Type: application/json' \
--data '{
    "taskName": "Declined Service",
    "taskDisplayName": "Declined Service",
    "taskDescription": "Follow up for declined service recommendations"
}'

Response

{
    "statusCode": 200,
    "error": null,
    "warnings": null,
    "updateSuccessful": true
}

Response Fields

Field	Type	Description
statusCode	integer	HTTP status code (200 for success)
error	object	Error details if the request failed
warnings	array	Warning messages if any
updateSuccessful	boolean	Indicates if the task type was created successfully