PApaymongo
Workflows

Update a workflow

Replaces the mutable fields of an existing workflow. Superuser only. Requires the current version in the If-Match header (optimistic lock). Body is the workflow YAML definition.

put/v1/workflows/{id}

Request

  • Base URL
    https://api.paymongo.com
  • URL
    https://api.paymongo.com/v1/workflows/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

Workflow ID

Headers

If-Matchinteger required

Current workflow version (optimistic lock)

Organization-Idstring required

Organization ID

Request body application/x-yaml

string required

Response

Updated workflow

created_atstring
definitionobject
descriptionstring
idstring
internalboolean
livemodeboolean
namestring
organization_idstring
updated_atstring
versioninteger

Example response

{
  "created_at": "2026-01-15 10:30:00+00:00",
  "description": "Handles merchant payout disbursement",
  "id": "flow_abc123",
  "livemode": true,
  "name": "Payout Workflow",
  "organization_id": "org_abc123",
  "updated_at": "2026-01-15 10:30:00+00:00",
  "version": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.