PRprocess
Scheduled Workflows

Update a scheduled workflow

Changed on

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

put/scheduled-workflows/{scheduledWorkflowId}

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/scheduled-workflows/{scheduledWorkflowId}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

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": "tv-HBiQ9eEgBoZxtdNh05A"
}

Response

Example response

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

Changes