WorkflowScheduledSteps - Create/Update

Create or update a workflow scheduled steps. Exclude hash and id to create, include hash to update.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

A system generated numerical id for the item. Cannot be altered.

string

A system generated unique id in the form of a hash to obscure numerical id.

string

The id of the scheduled workflow associated with this step.

string

The id of the workflow step this is associated with.

string

The date this workflow step is scheduled to fire.

string

The status of the workflow scheduled step.Pending -- The scheduled item is waiting to be fired based upon the scheduled date.Queued -- The scheduled item is being sent to the consumer for processing.Processing -- The scheduled item is being processed on the consumer.Missed -- The scheduled item passed the date but did not complete.Skipped -- The scheduled item has been paused and did not complete.Failed -- The scheduled item encoutered an error in the process.Canceled -- The scheduled item has been canceled.Repeating -- The scheduled item fired, finished, but is expected to repeat again.Completed -- The scheduled item has successfully fired and finished.

string

The date of the status.

string

Provides the reason a step was canceled.

string

Indicates whether this is the most current scheduled item for the contact and step.For repeating steps, this represents the most current repeated item.For steps that have been re-scheduled, this represents the most current repeat item.Only one workflow_scheduled_id and workflow_step_id combined should have 1 as current.

string

Indicates the datetime is locked. If any changes occur, the date will not be updated.

string

For a repeating item, this indicates the current count of this record in the repeat cycle.

string

Only when attached to a message.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json