MOmodern-treasury

Update Embeddable Flow

Changed on

Update an embeddable flow

patch/embeddable_flows/{id}

Request

  • Base URL
    https://app.moderntreasury.com/api
  • URL
    https://app.moderntreasury.com/api/embeddable_flows/{id}
  • Auth
    HTTP basic

Path parameters

idstring required

The ID of the embeddable flow.

Request body

status'cancelled' required

You may only transition a flow from pending to cancelled.

Response

200

idstring
objectstring
live_modeboolean
template'legal_entity_onboarding' | 'account_collection' | 'payment'
client_tokenstring
status'pending' | 'completed' | 'expired' | 'cancelled'
expires_atstring date-time

7 days after the last activity on the flow.

created_atstring date-time
updated_atstring date-time
optionsobject

The options from the request, plus any IDs created by Modern Treasury, such as legal_entity_id.

Example response

{
  "id": "0199f2c1-6a4e-7c2b-9d3f-5b8e1a2c4d6f",
  "object": "embeddable_flow",
  "live_mode": true,
  "template": "legal_entity_onboarding",
  "client_token": "le-live-fmsXHyYikKHstYHeSB6Co5AjezMqKoFKFhKmwnY2tvJMUFmndkarJY7GcwYkcBvr",
  "status": "cancelled",
  "expires_at": "2026-11-02T18:00:00Z",
  "created_at": "2026-10-26T18:00:00Z",
  "updated_at": "2026-10-26T18:00:00Z",
  "options": {
    "type": "individual",
    "legal_entity_id": "0199f2c1-6a51-7e8a-b2c4-8d0f3a5b7c9e"
  }
}

Changes