tasks

Complete a single task

post/v1/tasks/{taskId}/complete

Path parameters

taskIdstring required

Request body

callOutcome'Interested' | 'Callback Later' | 'Followup' | 'Not Interested' | 'Wrong Number' | 'No Answer' | 'Left Voicemail' | 'Not In Service'

Call outcome for call tasks (mandatory for call tasks)

Example request

{
  "callOutcome": "no-answer"
}

Response

Task marked as completed successfully

{"stackTrail":"paths:/v1/tasks/{taskId}/complete:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"message":"Task marked as completed successfully","payload":{"task":{"taskId":"lP0Zg2keMz","status":"completed","callOutcome":"interested"}}}}

Example response

{
  "message": "Task marked as completed successfully",
  "payload": {
    "task": {
      "taskId": "lP0Zg2keMz",
      "status": "completed",
      "callOutcome": "interested"
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.