Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Scheduled Workflows

Update a scheduled workflow

Updates a scheduled workflow. PUT semantics: all mutable fields must be provided. Rules and assignees are fully replaced.

put/scheduled-workflows/{scheduledWorkflowId}

Path parameters

scheduledWorkflowIdstring required

The ID of the scheduled workflow.

Request body

workflowIdstring required

The ID of the Workflow

namestring

Display name.

startDatestring date-time required
timeZonestring required
duePeriodstring
assigneeEmailsstring[]

Example request

{
  "workflowId": "hx5e8rSE9iKKuQ5B9OVIFg"
}

Response

Example response

{
  "data": {
    "workflowId": "qFf8oNzgS-u8KHicAFpDEA",
    "createdBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}