Skip to main content

Update Workflow Evaluation

PUT 

/api/automation/workflow-evaluations/:evaluation

Updates an evaluation. All body fields are optional (sometimes) — omitted name/test_data keep their current values.

Required scope: settings:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body fields:

  • name (string, optional, max 255)
  • description (string, nullable)
  • test_data (array, optional, min 1 item when present; each entry an object)
  • assertions (array, nullable)

Response: The updated evaluation wrapped in data.

Route name: automation.evaluations.update

Partial update: fields that are not sent keep their current values. Send description or assertions as null to clear them.

Request​

Responses​

OK

Response Headers
    Content-Type