Workflow Templates - Phases API

List all phases of a workflow template

List all of the phases of a workflow template with a specific ID:

GET /workflow_templates/:id/phases

status: 200 OK

[
  {
    "id": 4558,
    "...": "..."
  }
]

The response contains these fields by default.

GET /workflow_templates/:id/phases/:id

status: 200 OK

{
  "id": 4558,
  "...": "..."
}

The response contains these fields.

Add a phase to a workflow template with a specific ID.

POST /workflow_templates/:id/phases

When creating a new phase for a workflow template these fields are available.

status: 200 OK

{
  "id": 4558,
  "...": "..."
}

Update a phase with a specific ID of a workflow template with a specific ID.

PATCH /workflow_templates/:id/phases/:phase_id

When updating an existing phase for a workflow template these fields are available.

status: 200 OK

{
  "id": 4558,
  "...": "..."
}

Remove a phase with a specific ID from a workflow template with a specific ID.

DELETE /workflow_templates/:id/phases/:phase_id

status: 204 No Content

Remove all phases from a workflow template with a specific ID.

DELETE /workflow_templates/:id/phases

status: 204 No Content

created_at: Readonly datetime — The date and time at which the workflow template’s phase was created.
id: Readonly integer — The unique ID of the workflow template’s phase.
name: Required string (max 50) — The Name field is used to enter the name of the workflow template’s phase.
position: Optional integer — The Position field dictates the position that the phase takes when it is presented in its workflow template.
updated_at: Readonly datetime — The date and time of the last update of the workflow template’s phase. If the phase has no updates it contains the created_at value.