Preview the Approval Path

1 min

POST

https://api.nue.io/cpq/approvals:preview

Returns the approval routing a record would follow if it were submitted now, without submitting it or writing anything. requiresApproval reports whether any path applies at all; each path reports willTrigger with the reason, and each step lists its resolved approvers. Use this to surface required approvals while a quote can still be changed.

The response is the standard approvals envelope: status is SUCCESS or FAILURE, data carries the typed payload, and warnings and errors carry coded messages. Validation and engine failures are reported as coded errors on the envelope rather than as exceptions.

acceptstringGenerated from available response content types

bodyobject

200Approval routing previewed. Nothing is persisted.

400Missing or invalid parameter.

401Authentication failed or the Salesforce session is unavailable.

404Record not found.

429Salesforce limit exceeded.

500Unexpected or upstream failure.

curl --request POST \
     --url https://api.nue.io/cpq/approvals:preview \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "recordId": ""
     }'