Workflow Stage Object

This is an object representing a workflow stage.

Properties

id
number

The numeric ID
allow_publish
boolean

Boolean to allow publishing for all the users in the stage
is_default
boolean

True if the workflow stage is the default one for a particular workflow. One workflow can only have one default stage.
user_ids
number[]

An array of user ids that are allowed to change the stage to next available stages
space_role_ids
number[]

Space role ids that are allowed to change the stage to the next available stages
workflow_stage_ids
number[]

An array of IDs of next available stages
name
string

The workflow stage name, cannot be the same as another stage in the same workflow.
color
string

Workflow stage color, two stages in the same workflow cannot have the same color
allow_all_stages
boolean

Boolean to allow all stages as the next available stages
allow_admin_publish
boolean

Boolean to allow admin publishing
allow_all_users
boolean

Boolean to allow changing the workflow stage by all users
allow_admin_change
boolean

Allow admins to change from the current stage to the next available stages
allow_editor_change
boolean

Allow editors to change from the current stage to the next available stages
position
number

Numeric position of the workflow stage in the workflow
after_publish_id
number

Workflow stage id that gets assigned after publishing
workflow_id
number

Numeric ID of the connected workflow. If empty while creating a new stage, then the stage is created in the default workflow.

Example Object

    "workflow_stage": {
        "allow_publish": true,
        "is_default": true,
        "id": 561397,
        "user_ids": [
            123123
        ],
        "space_role_ids": [
            111111,
            222222
        ],
        "workflow_stage_ids": [
            321321
        ],
        "name": "test!!!",
        "color": "#11eeeb",
        "allow_all_stages": false,
        "allow_admin_publish": true,
        "allow_all_users": false,
        "allow_admin_change": true,
        "allow_editor_change": false,
        "position": 1,
        "after_publish_id": 444431,
        "workflow_id": 61816
    }

Prev Introduction

Next Retrieve a Single Workflow Stage