Sign in
tasks

Snooze a single task until a specified time

post/v1/tasks/{taskId}/snooze

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 (optional)

snoozeUntilstring required

Date and time until which the task should be snoozed

Example request

{
  "callOutcome": "no-answer",
  "snoozeUntil": "2024-06-17T05:55:38.434Z"
}

Response

Task snoozed successfully

{"stackTrail":"paths:/v1/tasks/{taskId}/snooze:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"message":"Task snoozed successfully","payload":{"task":{"taskId":"lP0Zg2keMz","status":"snoozed","snoozedUntil":"2024-06-17T05:55:38.434Z","callOutcome":"no-answer"}}}}

Example response

{
  "message": "Task snoozed successfully",
  "payload": {
    "task": {
      "taskId": "lP0Zg2keMz",
      "status": "snoozed",
      "snoozedUntil": "2024-06-17T05:55:38.434Z",
      "callOutcome": "no-answer"
    }
  }
}

Changes

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