Skip to navigation

Create native approval policy

View as Markdown

Creates a native approval policy and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
namestringRequiredformat: "^[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.
expressionobjectRequired
The approval decision tree for this workflow.
versionobjectRequired
Document version. On update, send back the num from your last read.

Response

The created native approval policy
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
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error