Skip to main content
POST
/
org
/
{org_id}
/
workflows
/
{workflow_id}
/
batches
Create workflow batch
curl --request POST \
  --url https://v2-nova-api.prod.czmx.in/org/{org_id}/workflows/{workflow_id}/batches \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "prospect_ids": [
    "<string>"
  ],
  "prospect_list_id": "<string>",
  "scheduled_at": "<string>"
}
'
{
  "created_at": "<string>",
  "created_by": "<string>",
  "id": "<string>",
  "name": "<string>",
  "organization_id": "<string>",
  "scheduled_at": "<string>",
  "source_type": "<string>",
  "stats": {
    "cancelled_count": 123,
    "failed_count": 123,
    "finished_count": 123,
    "in_progress_count": 123,
    "paused_count": 123,
    "pending_count": 123,
    "total_count": 123
  },
  "status": "<string>",
  "total_prospects": 123,
  "updated_at": "<string>",
  "workflow_id": "<string>",
  "workflow_version_id": "<string>",
  "workflow_version_number": 123
}

Path Parameters

org_id
string
required

Organization ID

workflow_id
string
required

Workflow ID

Body

application/json

Batch details

name
string
required
prospect_ids
string[]
prospect_list_id
string
scheduled_at
string

Response

Created

created_at
string
created_by
string
id
string
name
string
organization_id
string
scheduled_at
string
source_type
string
stats
object
status
string
total_prospects
integer
updated_at
string
workflow_id
string
workflow_version_id
string
workflow_version_number
integer