Browse documentation
Flows

Patch Flow

patch/v1/flow_templates/{flow_template_id}

Patch Flow

Authentication

Send your tenant secret key as a Bearer token. Keep secret keys on your server; never ship them in browser or mobile code.

Parameters

flow_template_id
path · required

No additional parameter description.

Request body

JSON · required

archived
boolean | null

No additional field description.

default_decision
FlowDecision | null

No additional field description.

description
string | null

No additional field description.

name
string | null

No additional field description.

required_checks
CheckType[] | null

No additional field description.

Example request

cURL
curl --request PATCH \
  --url 'https://api.fideralabs.com/v1/flow_templates/{flow_template_id}' \
  --header 'Authorization: Bearer $FIDERA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "archived": true,
  "default_decision": "string",
  "description": "string",
  "name": "string",
  "required_checks": [
    "string"
  ]
}'

Responses

200Successful Response
archived_at
string | nullrequired

No additional field description.

created_at
stringrequired

No additional field description.

default_decision
FlowDecisionrequired

No additional field description.

description
string | nullrequired

No additional field description.

id
stringrequired

No additional field description.

name
stringrequired

No additional field description.

required_checks
CheckType[]required

No additional field description.

required_documents
FlowDocumentRequirementOut[]

No additional field description.

slug
stringrequired

No additional field description.

updated_at
stringrequired

No additional field description.

application/json
{
  "archived_at": "2026-07-29T12:00:00Z",
  "created_at": "2026-07-29T12:00:00Z",
  "default_decision": "string",
  "description": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "required_checks": [
    "string"
  ],
  "required_documents": [
    {
      "min": 1,
      "side": {},
      "types": [
        {}
      ]
    }
  ],
  "slug": "string",
  "updated_at": "2026-07-29T12:00:00Z"
}
422Validation Error
detail
ValidationError[]

No additional field description.

Operation ID

patch_flow_v1_flow_templates__flow_template_id__patch