Skip to navigation

Update native approval policy

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole. The id goes in the URL; if you also send id in the body it must match.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Path parameters

idstringRequired

The id of the native approval policy, as returned when it was created or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
expressionobjectOptional
The approval decision tree for this workflow.

Response

The updated native approval policy, at its new version
idstringOptionalRead-only
Unique identifier of the workflow, assigned by the server.
namestringOptionalformat: "^[A-Z0-9a-z_-]+$"1-100 characters
Name of the workflow, used by other configurations to reference it. Must be unique in the org and cannot be changed after creation. Letters, numbers, underscores, and hyphens only.
expressionobjectOptional
The approval decision tree for this workflow.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error