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}/followup

Parameters

Required path parameters:

Parameter Name	Value	Description
dealerUUID	string	Unique identifier for the dealer

Authorization

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

Request Body

Property Name	Type	Description
customerUUID	string	Unique identifier of the customer for whom the follow-up is being created
taskTypeUUID	string	Unique identifier of the task type
dealerDepartmentUUID	string	Unique identifier of the dealer's department
dueDate	string	Due date of the task in UTC format (ISO 8601)
assignee	object	(Optional) Details of the user the task is assigned to
assignee.uuid	string	Unique identifier of the assignee
assignee.fname	string	First name of the assignee
assignee.lname	string	Last name of the assignee

Sample Request

curl --location 'https://api.mykaarma.com/leads/followup/dealer/{dealerUUID}/followup' \
--header 'accept: application/json' \
--header 'authorization: <your-credentials>' \
--header 'Content-Type: application/json' \
--data '{
    "customerUUID": "customer-uuid",
    "taskTypeUUID": "task-type-uuid",
    "dealerDepartmentUUID": "department-uuid",
    "dueDate": "2024-05-30T18:29:59.000+00:00",
    "assignee": {
        "uuid": "user-uuid",
        "fname": "John",
        "lname": "Doe"
    }
}'

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,
    "followUpUUID": "follow-up-uuid"
}

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
followUpUUID	string	Unique identifier of the created follow-up