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": "rtMPvgDhzR8F83keC7NIWg"
}

Response

Example response

{
  "data": {
    "workflowId": "kuAdUAYx-88IXcWRUQ1LbQ",
    "createdBy": {
      "id": "oU4EEGRPtELpR1x1YUJMeQ",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "oU4EEGRPtELpR1x1YUJMeQ",
      "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"
    }
  ]
}