tasks

Snooze multiple tasks with snooze duration or until a specific time

You can snooze up to 10,000 tasks at a time.

This can be a large request and may take some time to complete. But you will get response immediately after the request is submitted.

On request of this API, you will receive a bulkActionId that can be used to check the status of the snooze process.

To check the status of the snooze process, you can use the v1/tasks/bulk-status/{bulkActionId} API.

If there is any error during the snooze process, you will receive detailed error information in the status response.

post/v1/tasks/bulk-snooze

Request

Base URL
https://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/saleshandy/apis/develop-with-saleshandy/docs/v1/tasks/bulk-snooze/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

taskIdsstring[] required

Array of task IDs to snooze

snoozeUntilstring date-time required

Date and time until which the tasks should be snoozed

Example request

{
  "taskIds": [
    "lP0Zg2keMz",
    "MP0Cg1keMa",
    "BS0Zg5keMq"
  ],
  "snoozeUntil": "2024-06-17T05:55:38.434Z"
}

Response

Snooze request accepted. Use the bulk status API to track results.

bulkActionIdstring required

Unique identifier for the bulk action

messagestring required

Confirmation message

statusCheckUrlstring required

URL to check the status of the bulk action

Example response

{
  "bulkActionId": "lP0Zg2keMz",
  "message": "Snooze request accepted. Use the bulk status API to track results.",
  "statusCheckUrl": "/v1/tasks/bulk-status/lP0Zg2keMz"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.