Skip to main content
PUT
/
v1
/
steps
/
{id}
curl --request PUT \
  --url "https://h3-api-gateway.dev.h3aven.com/v1/steps/{id}" \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "label": "Updated Document Review",
    "description": "Review all submitted contract documents carefully"
  }'

​
Overview

Update an existing step with new data. You can modify basic step information, policies, dependencies, and other configuration options.

​
Request Examples

The request body can include various fields depending on what you want to update. Here are common update scenarios: 
{
  "label": "Updated Document Review",
  "description": "Review all submitted contract documents carefully"
}

​
Example Request

curl --request PUT \
  --url "https://h3-api-gateway.dev.h3aven.com/v1/steps/{id}" \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "label": "Updated Document Review",
    "description": "Review all submitted contract documents carefully"
  }'

​
Response

The endpoint returns a 204 No Content status code on successful update, indicating the step has been updated successfully without returning the updated data in the response body.

Path Parameters

​
id
string
required

Body

application/json
​
id
string
​
label
string
​
description
string
​
prompt
string
​
processId
string
​
tokenIds
string[]
​
policyNames
string[]
​
roles
object[]
​
orderedPolicies
string[]
​
viewPolicyNames
string[]
​
routing
object
​
webhookUrls
string
​
legalContractId
string
​
frequency
string
​
deadline
​
deadlineType
string
​
frequencyDate
​
createdAt
string
​
updatedAt
string
​
deletedAt
string
​
requireOrder
boolean
​
parameters
object[]
​
stepIdsDependencies
string[]
​
stepIdsReprovalDependencies
string[]

Response

204

ok