POST/projects/api/v3/workflows/{workflowId}/stages.json

Create a new stage for a workflow.

Creates a new stage for a workflow with the given id.

Path Params

  • Name
    workflowId
    Type
    integer
    required
    Description

Body Params

Request contains information of a stage to be created or updated.

    • Name
      stage
      Type
      object
      Description
      Stage contains all the information returned from a stage.
    • Name
      stageOptions
      Type
      object

    Responses

    • Code
      201
      Type
      object
      Schema
      Description
      201 Created
      Response contains information about a specific stage.
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      403
      Type
      object
      Schema
      Description
      403 Forbidden
      ErrorResponse defines how []Error should be marshaled to JSON.

    Examples

    201 Created

    Response
    {
      "included": {
        "users": {
          "additionalProp": {
            "avatarUrl": "string",
            "canAddProjects": true,
            "company": {
              "id": 0,
              "meta": {},
              "type": "string"
            },
            "companyId": 0,
            "companyRoleId": 0,
            "deleted": true,
            "email": "string",
            "firstName": "string",
            "id": 0,
            "isAdmin": true,
            "isClientUser": true,
            "isServiceAccount": true,
            "lastName": "string",
            "lengthOfDay": 0,
            "meta": {},
            "teams": [
              {
                "id": 0,
                "meta": {},
                "type": "string"
              }
            ],
            "timezone": "string",
            "title": "string",
            "type": "string",
            "userCost": 0,
            "userRate": 0,
            "workingHour": {
              "id": 0,
              "meta": {},
              "type": "string"
            },
            "workingHoursId": 0
          }
        },
        "workflows": {
          "additionalProp": {
            "createdAt": "string",
            "createdBy": 0,
            "defaultWorkflow": true,
            "id": 0,
            "lockdown": {
              "id": 0,
              "meta": {},
              "type": "string"
            },
            "name": "string",
            "projectIds": [
              0
            ],
            "projectSpecific": true,
            "stages": [
              {
                "id": 0,
                "meta": {},
                "type": "string"
              }
            ],
            "status": "string",
            "updatedAt": "string",
            "updatedBy": 0
          }
        }
      },
      "stage": {
        "color": "string",
        "createdAt": "string",
        "createdBy": 0,
        "deletedAt": "string",
        "deletedBy": 0,
        "displayOrder": 0,
        "id": 0,
        "name": "string",
        "showCompletedTasks": true,
        "taskIds": [
          0
        ],
        "updatedAt": "string",
        "updatedBy": 0,
        "workflow": {
          "id": 0,
          "meta": {},
          "type": "string"
        }
      }
    }