Skip to main content
POST
Create Activity

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Body

application/json
workflowId
string
required

ID of the Workflow that defines the steps for this Activity. Must reference an existing Workflow in your organization.

Example:

"68f2198aef526585c30e16d2"

tasks
object[]
required

Array of step task objects. The array length must equal the Workflow's number of steps; the order of objects matches the order of workflow.steps. Each object carries the schedule, assignee, and Flow-specific data fields for one Workflow step.

hubId
string

Optional hub ID where this Activity is executed. Inherited by all child tasks.

Example:

"68ff42815ed967adac0f7192"

Response

Activity created successfully. The response contains the master task object. workflow.steps is omitted from the response to reduce payload size — read the Workflow directly if you need the step definitions.

status
boolean
Example:

true

code
integer
Example:

201

message
string
Example:

"Activity created successfully"

data
object

The newly-created Activity master task. The shape follows the standard Task object with taskType = activityMaster.