WorkflowSteps - Create/Update

post

https://api.textinchurch.com/API/1_0/workflowSteps.php

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

workflow_step_id

string

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

hash

string

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

workflow_step_name

string

The name of the item.

workflow_step_is_active

string

Indicates whether the item is in-use or not.

workflow_step_is_immediate

string

Indicates whether the step fires immediately or is set on a delay.

workflow_step_deleted

string

Indicates whether the step is deleted or not.Deleted steps are ignored by the system but are preservedin case the data needs to be restored.

workflow_step_deleted_date

string

Indicates whether the step is deleted or not.Deleted steps are ignored by the system but are preservedin case the data needs to be restored.

workflow_step_deleted_by_user_id

string

Indicates whether the step is deleted or not.Deleted steps are ignored by the system but are preservedin case the data needs to be restored.

workflow_step_description

string

Details concerning the workflow step.

workflow_id

string

The id of the associated workflow to which the step belongs.

workflow_step_type_id

string

The id of the associated workflow step type.

workflow_step_delay

string

The delay to wait before sending this workflow item relative to the start.Can be negative to indicate occurs before date.

workflow_step_delay_interval

string

This is the interval that controls the delay. Values: minute, hour, day.

workflow_step_on_day

string

Indicates whether step happens on a day or not.

workflow_step_dow

string

Integer indicating day of week where 0 = Sun, 6 = Sat, -1 = Any Day, -2 = Week Days.

workflow_step_hour

string

Hour 0-23 indicating when the step should run. This will be local time.

workflow_step_minute

string

Minute 0-59 indicating when the step should run. This will be local time.

workflow_step_repeat

string

Flag indicating if the step repeats or not.

workflow_step_repeat_frequency

string

Indicates how often the repeat happens. Values: day, week, month, year.

workflow_step_repeat_num

string

How many times the repeat should happen before ending.A negative one indicates it will never end.

workflow_step_data

string

Contains JSON of data based upon structure in workflow_step_types.workflow_step_data.Internally, this should always be an array except when saving as JSON to the database.

workflow_step_user_id

string

Id of user who created the workflow.

workflow_step_stamp

string

The date the step was last modified.

date_created

string

The date the step was created.

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK