How to update follow ups

This endpoint allows you to update follow-ups to mark them as complete, archive them, or change their assignees.

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

PUT  https://api.mykaarma.com/leads/followup/department/{departmentUUID}/user/{userUUID}/list

Parameters

Required path parameters:

Parameter Name	Value	Description
`departmentUUID`	`string`	Unique identifier for the department of the dealer (use the department of the follow-up)
`userUUID`	`string`	Unique identifier of the user through whom the action is being taken

Authorization

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

Request Body

Property Name	Type	Description
`followUpUUIDs`	`array`	List of unique identifiers for the follow-ups that need to be updated
`followUpActionType`	`string`	An ENUM that defines the action to be taken on the follow-ups. Use one of: `MARK_AS_DONE`, `ARCHIVE`, `ASSIGN`, `UNASSIGN`
`newAssignee`	`object`	(Required if `followUpActionType` is `ASSIGN`) Details of the new assignee
`newAssignee.uuid`	`string`	Unique identifier of the user
`newAssignee.fname`	`string`	First name of the user taking the action
`newAssignee.lname`	`string`	Last name of the user taking the action
`actionTakenBy`	`object`	Details of the user that is taking the action
`actionTakenBy.uuid`	`string`	Unique identifier of the user
`actionTakenBy.fname`	`string`	First name of the user taking the action
`actionTakenBy.lname`	`string`	Last name of the user taking the action

Follow-up Action Types

Action Type	Description
`MARK_AS_DONE`	Marks the follow-up status as `COMPLETE`
`ARCHIVE`	Archives the follow-ups
`ASSIGN`	Assigns the follow-up to a user. Please send the `newAssignee` field with this action
`UNASSIGN`	Unassigns the follow-up from the existing assigned user

Sample Request - Mark as Done

curl --location --request PUT 'https://api.mykaarma.com/leads/followup/department/{departmentUUID}/user/{userUUID}/list' \
--header 'accept: application/json' \
--header 'authorization: <your-credentials>' \
--header 'Content-Type: application/json' \
--data '{
    "followUpUUIDs": ["follow-up-uuid-1", "follow-up-uuid-2"],
    "followUpActionType": "MARK_AS_DONE",
    "actionTakenBy": {
        "uuid": "user-uuid",
        "fname": "John",
        "lname": "Doe"
    }
}'

Sample Request - Assign Follow-up

curl --location --request PUT 'https://api.mykaarma.com/leads/followup/department/{departmentUUID}/user/{userUUID}/list' \
--header 'accept: application/json' \
--header 'authorization: <your-credentials>' \
--header 'Content-Type: application/json' \
--data '{
    "followUpUUIDs": ["follow-up-uuid"],
    "followUpActionType": "ASSIGN",
    "newAssignee": {
        "uuid": "new-assignee-uuid",
        "fname": "Jane",
        "lname": "Smith"
    },
    "actionTakenBy": {
        "uuid": "user-uuid",
        "fname": "John",
        "lname": "Doe"
    }
}'

Sample Request - Archive Follow-up

curl --location --request PUT 'https://api.mykaarma.com/leads/followup/department/{departmentUUID}/user/{userUUID}/list' \
--header 'accept: application/json' \
--header 'authorization: <your-credentials>' \
--header 'Content-Type: application/json' \
--data '{
    "followUpUUIDs": ["follow-up-uuid"],
    "followUpActionType": "ARCHIVE",
    "actionTakenBy": {
        "uuid": "user-uuid",
        "fname": "John",
        "lname": "Doe"
    }
}'

Response

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

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 update was successful
`archivedFollowUpUUIDList`	`array`	List of unique identifiers of follow-ups that were already archived before this request was made, so no update took place for them

tip

If a follow-up is already archived, it will be included in archivedFollowUpUUIDList and no update will be performed for it
Use ASSIGN action type to reassign follow-ups to different users
Use UNASSIGN to remove assignment from follow-ups

Request​

HTTP request​

Parameters​

Authorization​

Request Body​

Follow-up Action Types​

Sample Request - Mark as Done​

Sample Request - Assign Follow-up​

Sample Request - Archive Follow-up​

Response​

Response Fields​