v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB

Workflows

Updates a workflow configuration version

Updates the description attribute of a workflow configuration version.

patch/merchant/workflows/{workflowCode}/versions/{workflowVersion}

workflowCodestring required

Machine-friendly code of Workflow.

Path parameter to specify the workflow code.

workflowVersionnumber required

Workflow configuration version.

Path parameter to specify the workflow version.

workspaceIdstring uuid

Workspace ID that the workflow configuration belongs to.

descriptionstring

Description for the workflow configuration.

Created.

createdAtstring date-time required

Creation date of the workflow configuration.

workflowCodestring required

Machine-friendly code of Workflow.

workspaceIdstring uuid required

Workspace ID that the workflow configuration belongs to.

createdBystring email

User email. The values are set with the credentials of the request owner.

descriptionstring

Description for the workflow.

versioninteger required

Version of a Workflow Configuration.

setAsDefaultBystring email nullable

User email who set this workflow version as default.

setAsDefaultAtstring date-time

Timestamp when this configuration was set as default.