Update an approval process step by ID

put

https://rls.congacloud.com/api/approvals/v1/process/{id}/process-steps/{processStepId}

Updates an approval process step by ID, using several required parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The process ID

processStepId

string

required

The process step ID

Body Params

The approval process step request

ApprovalProcessId

string | null

ProcessName

string | null

ObjectType

string | null

ProcessStepGroupId

string | null

CustomAssigneePayload

string | null

Name

string | null

Active

boolean

required

ApproverType

string | null

AssigneeDescription

string | null

AutoComplete

boolean

EscalationEnabled

boolean

required

ReminderEnabled

boolean

required

AutoReapprovalCriteria

string | null

ChildObjectType

string | null

CriteriaFieldNames

string | null

DependsOn

string | null

Description

string | null

DisplayFieldNameHeader

string | null

DisplayFieldNames

string | null

FilterConditionDescription

string | null

FilterLogic

string | null

HierarchyDriver

string | null

KeyFieldNames

string | null

NotifyOnly

boolean

SendEmail

boolean

SendChat

boolean | null

StepName

string

required

length ≥ 1

StepType

string

required

length ≥ 1

SubmissionComment1Enabled

boolean

SubmissionComment2Enabled

boolean

SubmissionComment3Enabled

boolean

SubmissionCommentsEnabled

boolean

SkipUnresolvedAssignee

boolean

AssigneeId

string | null

AssigneeType

string

required

length ≥ 1

CCEmailRecipients

string | null

Escalation

Reminders

array of objects | null

Reminders

StepEntryCriteria

array of objects | null

StepEntryCriteria

Response

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200An approval process definition including the updated step