Workflow Leads

Upload Workflow Leads

Uploads and enrolls leads in one workflow from a CSV or Excel file. On a draft workflow the upload replaces every existing lead; on an active or paused workflow it adds to them. Leads uploaded to an active workflow start immediately; leads uploaded to a paused workflow start only when the workflow is activated again with activate. A 201 can be a partial success: rows listed in errors either could not be saved or, on an active workflow, were saved but could not start; a saved row is still counted in data and count.

post/v1/workflows/{workflowId}/leads

Request

  • Base URL: https://api.dialnexa.com
  • URL: https://api.dialnexa.com/v1/workflows/{workflowId}/leads
  • Auth: HTTP bearer

Path parameters

workflowIdstring required
Example:workflow_abc123

Workflow ID

Response

File processed successfully.

successtrue required
errorfalse required
statusCodeinteger required
messagestring required
timestampstring date-time required

Example response

{
  "statusCode": 201,
  "message": "Success",
  "data": {
    "statusCode": 201,
    "message": "Leads uploaded successfully",
    "count": 1
  }
}

Changes

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