EPepilot
bulk

patchBulkJob

Changed on

Approve / Cancel / Restart a bulk job that triggers multiple automation executions.

A failed or cancelled job can be restarted with the RESTART action: it continues where it left off, only triggering the entities whose executions were not started yet.

patch/v1/automation/executions/bulk-jobs/{job_id}

Request

  • Base URL
    https://automation.sls.epilot.io
  • URL
    https://automation.sls.epilot.io/v1/automation/executions/bulk-jobs/{job_id}
  • Auth
    HTTP bearer

Path parameters

job_idstring required

Job ID for tracking the status of bulk trigger automation executions

Example:8c086140-f33e-4bb7-a993-50c0f2402c7b

Request body

action'APPROVE' | 'CANCEL' | 'RESTART' required
  • APPROVE: Start the approved bulk job. Requires the task_token of the job.
  • CANCEL: Cancel the bulk job. Executions that already started keep running.
  • RESTART: Restart a failed or cancelled bulk job and continue where it left off. Entities whose executions were not started yet are triggered, executions that already started or finished are left untouched. If the entities were not fully loaded yet, they are loaded again from scratch. A job that was never approved goes back to approval.
task_tokenstring

Task token of the job. Required for the APPROVE action.

Response

Bulk Job Info

job_idstring required

Job ID for tracking the status of bulk trigger automation executions

org_idstring required
flow_idstring required

ID of the Automation Flow

status'approval' | 'querying_entities' | 'entities_loaded' | 'executing' | 'monitoring' | 'send_report' | 'finished' | 'failed' | 'cancelled' required

Status of the bulk trigger automation job

  • approval: Waiting for user approval to start the bulk trigger automation
  • querying_entities: Loading entities in batches
  • entities_loaded: All entities have been loaded and stored
  • executing: Automation execution are currently running
  • monitoring: All executions have been started, now monitoring their completion
  • send_report: Automation executions finished running. Report is being created & sent to the user who initiated the bulk trigger automation
  • finished: Automation executions finished running. Some may have failed. Check the status of each entity.
  • failed: Bulk trigger automation execution failed. Some executions might have started. Check the status of each entity.
  • cancelled: Bulk trigger automation execution was cancelled
created_bystring required

User ID who created the bulk trigger automation job

created_atstring date-time required
updated_atstring date-time required
approved_atstring date-time

Time when the bulk trigger automation executions job was approved

trigger_contextTriggerContext

Additional contextual data for a bulk trigger automation. This would normally include additional entity IDs you'd need after a listener picks up an event.

task_tokenstring

Task token to approve/cancel the bulk automation job

report_file_entity_idstring

Entity ID of the report file entity

last_errorstring

Error that moved the job into the failed status. Cleared when the job is restarted.

restart_countinteger

How many times the job was restarted after failing or being cancelled

restarted_atstring date-time

Time of the last restart of the job

execution_summary_truncatedboolean

True when execution_summary does not contain all execution items of the job (the response was bounded, or the summary was not requested).

Example response

{
  "job_id": "8c086140-f33e-4bb7-a993-50c0f2402c7b",
  "org_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
  "flow_id": "7791b04a-16d2-44a2-9af9-2d59c25c512f",
  "created_by": "1234",
  "trigger_context": {
    "entity_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
  },
  "task_token": "8c086140-f33e-4bb7-a993-50c0f2402c7b",
  "last_error": "ThrottlingException: Throughput exceeds the current capacity of your table or index.",
  "restart_count": 1,
  "entity_query": {
    "data": [
      {
        "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74"
      }
    ]
  },
  "execution_summary": [
    {
      "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
      "execution_id": "9baf184f-bc81-4128-bca3-d974c90a12c4",
      "timestamp": "2025-10-30T15:56:47.842Z"
    }
  ],
  "execution_stats": {
    "total": 60582
  }
}

Changes

  • 216ddb3913faRevision changes
    • info

      the request property became optional

    • info

      added the new RESTART enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status