ConnectCloud Developers

Switch workflows on or off for the tenant (tenant:settings:write)

PUT /api/workflow/v1/config

Module: Workflow · operationId: updateWorkflowConfig · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)

active is the only writable field (userEmailField is accepted and ignored). lastUpdate and lastEditor are set by the server; sending them or any other field answers 400 invalid with every field in details.fields. While workflows are off, nothing starts and step completions are ignored; pending trade write-backs are still delivered.

Request body

application/json (required)

  • active (boolean, required): Whether workflows run for the tenant

Example:

{
  "active": true
}

Responses

  • 200 Saved (application/json)
  • 400 Error (application/json)
  • 401 Missing or invalid token (unauthorized) (application/json)
  • 403 Error (application/json)
  • 500 Error (application/json)

Fields of the 200 answer:

  • active (boolean): Whether workflows run for the tenant
  • lastEditor (string, read-only): E-mail of the last editor
  • lastUpdate (string (date-time), nullable, read-only): Last change of the configuration
  • userEmailField (string): No longer used

Example 200 answer:

{
  "active": true,
  "lastEditor": "laura.kaestner@muster-it.example",
  "lastUpdate": "2026-10-14T13:20:11Z"
}

Example request

curl -X PUT 'https://api.mbcom.cloud/api/workflow/v1/config' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"active":true}'

View as Markdown · Interactive reference · OpenAPI