tasks

Retrieve the status of all tasks affected by a bulk action and download a CSV

While performing bulk operations using v1/tasks/bulk-snooze and v1/tasks/bulk-skip, you will receive the bulkActionId.

Using that bulkActionId, you can check the status of the bulk operation process. If there is any error during the bulk operation process, you will receive a CSV file link containing the error details.

get/v1/tasks/bulk-status/{bulkActionId}

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-status/:bulkActionId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

bulkActionIdstring required

Response

Bulk task status fetched successfully

bulkActionIdstring required

Unique identifier for the bulk action

action'snooze' | 'skip' required

Type of bulk action performed

totalTasksnumber required

Total number of tasks in the bulk action

completednumber required

Number of tasks completed successfully

failednumber required

Number of tasks that failed

pendingnumber

Number of pending tasks (only present when status is in_progress)

status'in_progress' | 'completed' | 'failed' required

Current status of the bulk action

createdAtstring date-time required

Date and time when the bulk action was created

completedAtstring date-time nullable required

Date and time when the bulk action was completed (null if in progress)

csvDownloadLinkstring nullable required

Download link for CSV with detailed results (null if in progress)

Example response

{
  "bulkActionId": "lP0Zg2keMz",
  "action": "snooze",
  "totalTasks": 3,
  "completed": 3,
  "pending": 5,
  "status": "completed",
  "createdAt": "2024-06-17T05:55:38.434Z",
  "completedAt": "2024-06-19T05:55:38.434Z",
  "csvDownloadLink": "https://my.saleshandy.com/api/edge/tasks/export/file?fileName=task_bulk_update_failed_report_62bc067f77_20250811_121241.csv"
}

Changes

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