Skip to main content
PATCH
/
api
/
rf
/
flows
/
{id}
Update an HHD flow
curl --request PATCH \
  --url https://clarus-api.com/api/rf/flows/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "rf_flows",
    "attributes": {
      "name": "<string>",
      "implementation_id": 123,
      "is_default": true,
      "definition": {}
    }
  }
}
'
{
  "error": "<string>"
}

​
Request Structure

{
  "data": {
    "type": "rf_flows",
    "attributes": {
      "name": "Standard Pick Flow v2",
      "is_default": true
    }
  }
}

​
Key Fields

FieldRequiredDescription
nameNoDisplay name
flow_typeNostandard, task, or loading
is_defaultNoDefault flow status
definitionNoJSON definition
code cannot be updated. Use the duplicate endpoint to create a new flow with a different code.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

​
id
integer
required

The unique identifier of the HHD flow to update

Body

application/json
​
data
object
required

Response

Operation completed successfully with no content to return