Workflows

Update a workflow's name or description

Changed on

Updates the name/description of a workflow, without a full publish. A key present in the body but set to "" clears that field; a key omitted entirely leaves it untouched. At least one of name/description must be present.

patch/workflows/{workflowId}/metadata

Request

  • Base URL: https://run-workflow.adobe.io
  • URL: https://run-workflow.adobe.io/workflows/{workflowId}/metadata
  • Auth: HTTP bearer and API key in header x-api-key

Path parameters

workflowIdstring required

Headers

x-gw-ims-org-idstring required

IMS organization ID for the authenticated caller. Scopes every request to that organization.

x-gw-ims-user-idstring required

IMS user ID for the authenticated caller.

Request body

namestring

New workflow display name.

descriptionstring

New workflow description.

Response

Workflow metadata updated.

status'succeeded'
workflowIdstring
messagestring

Changes