Update workflow metadata

Updates workflow metadata: key, visibility, pause state, concurrency limit, failure thresholds, and retention policy.

RBAC · workflow

Path parameters

workflowIdstring <uuid>Required

Request body

Content type: application/json · schema WorkflowMetadataBody

keystring

isVisibleboolean

isPausedboolean

concurrencyLimitinteger

≥ 0

autoPauseOnFailureboolean

failureRateThresholdnumber

≥ 0 · ≤ 1

failureRateMinRunsinteger

≥ 0

retentionPolicyOverrideobject

Response body

Success response 200 · schema UnversionedV1Success

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Metadata updated.

400

Invalid request.

401

API key missing/invalid.

403

Caller lacks the required permission.

404

Workflow not found.

500

Unexpected error.

PUT /api/workflow-definitions/{workflowId}/metadata

cURL

curl -X PUT "https://algapsa.com/api/workflow-definitions/{workflowId}/metadata" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "string",
  "isVisible": false,
  "isPaused": false,
  "concurrencyLimit": 0,
  "autoPauseOnFailure": false,
  "failureRateThreshold": 0,
  "failureRateMinRuns": 0,
  "retentionPolicyOverride": {}
}'

TypeScript

const response = await fetch("https://algapsa.com/api/workflow-definitions/{workflowId}/metadata", {
  method: "PUT",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "key": "string",
    "isVisible": false,
    "isPaused": false,
    "concurrencyLimit": 0,
    "autoPauseOnFailure": false,
    "failureRateThreshold": 0,
    "failureRateMinRuns": 0,
    "retentionPolicyOverride": {}
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://algapsa.com/api/workflow-definitions/{workflowId}/metadata");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""key"": ""string"",
  ""isVisible"": false,
  ""isPaused"": false,
  ""concurrencyLimit"": 0,
  ""autoPauseOnFailure"": false,
  ""failureRateThreshold"": 0,
  ""failureRateMinRuns"": 0,
  ""retentionPolicyOverride"": {}
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}