How to create a follow up for a customer

This endpoint allows you to create a follow-up task for a specific customer. Follow-ups are used to track and manage customer outreach tasks such as declined services, missed appointments, or other customer engagement activities.

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.

Need to find or create a customer first? See how to search and create a customer

Request

HTTP request

POST  https://api.mykaarma.com/leads/followup/dealer/{dealerUUID}/customer/{customerUUID}/create

Parameters

Required path parameters:

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

Authorization

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

Request Body

Property Name	Type	Description
dealerUuid	string	Unique identifier for the dealer
departmentUuid	string	Unique identifier for the department
customerUuid	string	Unique identifier for the customer
source	string	Task type name. Use only a name of the created task type otherwise it will create a new task type of this name
vehicle	object	(Optional) Vehicle details
vehicle.uuid	string	(Optional) Unique identifier for the vehicle
assignee	object	(Optional) Details of the user the task is assigned to
assignee.uuid	string	(Optional) Unique identifier of the user to whom you want to assign
taskName	string	Name of the follow up task to be created

Sample Request

curl --location 'https://api.mykaarma.com/leads/followup/dealer/{dealerUUID}/customer/{customerUUID}/create' \
--header 'accept: application/json' \
--header 'authorization: <your-credentials>' \
--header 'Content-Type: application/json' \
--data '{
    "dealerUuid": "",
    "departmentUuid": "",
    "customerUuid": "",
    "source": "",
    "vehicle": {
        "uuid": ""
    },
    "assignee": {
        "uuid": ""
    },
    "taskName": ""
}'

Important

You will need the unique identifier for the customer for whom you are creating the follow-up. Please use the customer search endpoint to find the customer UUID.

Response

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

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