---
title: "update workflow"
method: PUT
path: "/workflow/{id}"
tags: ["workflow"]
---

# update workflow

`PUT /workflow/{id}`

update workflow by ID

## Path parameters

- `id` string, required

## Request body

- CacaoPlaybook
  - `agent_definitions` object
  - `authentication_info_definitions` object
  - `created` string, required — date time is already validate by the field type!
  - `created_by` string, required
  - `data_marking_definitions` CacaoDataMarking
    - `affected_party_notifications` string
    - `attribution` string
    - `created` string
    - `created_by` string
    - `description` string
    - `encrypt_in_transit` string
    - `end_date` string
    - `external_references` CacaoExternalReferences[]
      - `description` string, required
      - `name` string, required
      - `source` string, required
      - `url` string, required
    - `id` string
    - `iep_version` string
    - `labels` string[]
    - `name` string
    - `permitted_actions` string
    - `revoked` boolean
    - `start_date` string
    - `statement` string
    - `tlp` string
    - `tlpv2_level` string
    - `type` string
    - `unmodified_resale` string
    - `valid_from` string
    - `valid_until` string
  - `derived_from` string[]
  - `description` string, required
  - `external_references` CacaoExternalReferences[], required
    - `description` string, required
    - `name` string, required
    - `source` string, required
    - `url` string, required
  - `id` string, required
  - `impact` integer, required
  - `labels` string[], required
  - `markings` string[]
  - `modified` string, required — ,datetime=2006-01-02T15:04:05Z07:00"`
  - `name` string, required
  - `playbook_types` string[], required
  - `priority` integer, required
  - `severity` integer, required
  - `spec_version` string, required
  - `target_definitions` object
  - `type` string, required
  - `valid_from` string, required
  - `valid_until` string, required
  - `workflow` CacaoWorkflow, required
  - `workflow_exception` string, required
  - `workflow_start` string, required

## Response `200`

OK

- CacaoPlaybook
  - `agent_definitions` object
  - `authentication_info_definitions` object
  - `created` string, required — date time is already validate by the field type!
  - `created_by` string, required
  - `data_marking_definitions` CacaoDataMarking
    - `affected_party_notifications` string
    - `attribution` string
    - `created` string
    - `created_by` string
    - `description` string
    - `encrypt_in_transit` string
    - `end_date` string
    - `external_references` CacaoExternalReferences[]
      - `description` string, required
      - `name` string, required
      - `source` string, required
      - `url` string, required
    - `id` string
    - `iep_version` string
    - `labels` string[]
    - `name` string
    - `permitted_actions` string
    - `revoked` boolean
    - `start_date` string
    - `statement` string
    - `tlp` string
    - `tlpv2_level` string
    - `type` string
    - `unmodified_resale` string
    - `valid_from` string
    - `valid_until` string
  - `derived_from` string[]
  - `description` string, required
  - `external_references` CacaoExternalReferences[], required
    - `description` string, required
    - `name` string, required
    - `source` string, required
    - `url` string, required
  - `id` string, required
  - `impact` integer, required
  - `labels` string[], required
  - `markings` string[]
  - `modified` string, required — ,datetime=2006-01-02T15:04:05Z07:00"`
  - `name` string, required
  - `playbook_types` string[], required
  - `priority` integer, required
  - `severity` integer, required
  - `spec_version` string, required
  - `target_definitions` object
  - `type` string, required
  - `valid_from` string, required
  - `valid_until` string, required
  - `workflow` CacaoWorkflow, required
  - `workflow_exception` string, required
  - `workflow_start` string, required

## Changes

- **2024-03-06** `53bae137e6cc` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/cossas/apis/soarca-api/changes/workflow/:id/put.md)

---

[API](https://skmtc.dev/cossas/apis/soarca-api.md) · [All operations](https://skmtc.dev/cossas/apis/soarca-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cossas/soarca-api/revisions/53bae137e6cc/schema)