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.
SUCCESS or FAILURE.
false when no configured path applies to the record.
Step-level rollup status.
" }, { "name": "triggerReason", "kind": "optional", "type": "string", "description": "Why this step applies to the record." }, { "name": "approvalReason", "kind": "optional", "type": "string", "description": "The configured reason recorded when the step is approved." }, { "name": "resolveOn", "kind": "optional", "type": "string", "description": "How the step resolves, e.g. when all or any approver responds.
" }, { "name": "numberOfApprovers", "kind": "optional", "type": "integer", "description": "" }, { "name": "dependsOnStepId", "kind": "optional", "type": "string", "description": "Step that must resolve before this one becomes active." }, { "name": "isRemembered", "kind": "optional", "type": "boolean", "description": "Whether a prior decision is reused for this step." }, { "name": "approvers", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/ApprovalApprover", "customType": "ApprovalApprover[]", "schema": [ { "name": "approverType", "kind": "optional", "type": "string", "description": "How the approver is resolved, e.g. User, Group, Role.
A coded message returned on the envelope. Validation and engine failures are reported here rather than thrown, so a FAILURE response is still a well-formed body.
", "modelRef": "#/components/schemas/ApprovalMessage", "customType": "ApprovalMessage[]", "schema": [ { "name": "severity", "kind": "optional", "type": "string", "description": "ERROR, WARNING, or INFO.
Stable machine-readable code, e.g. INVALID_PARAMETER, MISSING_PARAMETER, RECORD_NOT_FOUND.
Human-readable explanation.
" } ] }, { "name": "errors", "kind": "optional", "type": "array", "description": "A coded message returned on the envelope. Validation and engine failures are reported here rather than thrown, so a FAILURE response is still a well-formed body.
", "modelRef": "#/components/schemas/ApprovalMessage", "customType": "ApprovalMessage[]", "schema": [ { "name": "severity", "kind": "optional", "type": "string", "description": "ERROR, WARNING, or INFO.
Stable machine-readable code, e.g. INVALID_PARAMETER, MISSING_PARAMETER, RECORD_NOT_FOUND.
Human-readable explanation.
" } ] } ], "modelRef": "#/components/schemas/ApprovalPreviewResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "Missing or invalid parameter.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Envelope returned by the approval action verbs.", "customType": "ApprovalActionResponse", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "SUCCESS or FAILURE.
A coded message returned on the envelope. Validation and engine failures are reported here rather than thrown, so a FAILURE response is still a well-formed body.
", "modelRef": "#/components/schemas/ApprovalMessage", "customType": "ApprovalMessage[]", "schema": [ { "name": "severity", "kind": "optional", "type": "string", "description": "ERROR, WARNING, or INFO.
Stable machine-readable code, e.g. INVALID_PARAMETER, MISSING_PARAMETER, RECORD_NOT_FOUND.
Human-readable explanation.
" } ] }, { "name": "errors", "kind": "optional", "type": "array", "description": "A coded message returned on the envelope. Validation and engine failures are reported here rather than thrown, so a FAILURE response is still a well-formed body.
", "modelRef": "#/components/schemas/ApprovalMessage", "customType": "ApprovalMessage[]", "schema": [ { "name": "severity", "kind": "optional", "type": "string", "description": "ERROR, WARNING, or INFO.
Stable machine-readable code, e.g. INVALID_PARAMETER, MISSING_PARAMETER, RECORD_NOT_FOUND.
Human-readable explanation.
" } ] } ], "modelRef": "#/components/schemas/ApprovalActionResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Authentication failed or the Salesforce session is unavailable.", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Record not found.", "jsonExample": "", "isExpanded": true }, { "statusCode": "429", "description": "Salesforce limit exceeded.", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Unexpected or upstream failure.", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "wtlu7x_fdczegLhDsGQjL", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.nue.io/cpq/approvals:preview \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"recordId\": \"\"\n }'" }, { "id": "F0mP99uhxFI7YcfI5jU16", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"recordId\": \"\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/cpq/approvals:preview\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "HkkCYuo0R6hUPn-fTWd37", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/cpq/approvals:preview\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"recordId\": \"\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "DpBECNKi6UWwkWypRSM7Y", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/cpq/approvals:preview\"\n\npayload = json.dumps({\n \"recordId\": \"\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "wtlu7x_fdczegLhDsGQjL" }, "results": { "languages": [ { "id": "LIASAoYxCYTa3vFWaFRB-", "language": "200", "code": "// Approval routing previewed. Nothing is persisted.\n{\n \"status\": \"\",\n \"data\": {\n \"recordId\": \"\",\n \"requiresApproval\": false,\n \"resolvedProcessName\": \"\",\n \"paths\": [\n {\n \"pathId\": \"\",\n \"pathName\": \"\",\n \"willTrigger\": false,\n \"dependsOnPathId\": \"\",\n \"steps\": [\n {\n \"stepId\": \"\",\n \"stepName\": \"\",\n \"stepStatus\": \"\",\n \"triggerReason\": \"\",\n \"approvalReason\": \"\",\n \"resolveOn\": \"\",\n \"numberOfApprovers\": 0,\n \"dependsOnStepId\": \"\",\n \"isRemembered\": false,\n \"approvers\": [\n {\n \"approverType\": \"\",\n \"userId\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ]\n }\n ]\n },\n \"warnings\": [\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"errors\": [\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}" }, { "id": "kC8ZE-Eg4MXBXFamPM5it", "language": "400", "code": "// Missing or invalid parameter.\n{\n \"status\": \"\",\n \"data\": {\n \"requestId\": \"\",\n \"recordId\": \"\",\n \"status\": \"\",\n \"isLocked\": false,\n \"approvers\": [\n {\n \"approvalId\": \"\",\n \"stepName\": \"\",\n \"stepStatus\": \"\",\n \"approverUserId\": \"\",\n \"originalApproverUserId\": \"\",\n \"reassignedFromApprovalId\": \"\",\n \"rejectionMessage\": \"\"\n }\n ],\n \"approvals\": [\n {\n \"approvalId\": \"\",\n \"stepName\": \"\",\n \"stepStatus\": \"\",\n \"approverUserId\": \"\",\n \"originalApproverUserId\": \"\",\n \"reassignedFromApprovalId\": \"\",\n \"rejectionMessage\": \"\"\n }\n ]\n },\n \"warnings\": [\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"errors\": [\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}" }, { "id": "D5skPsN87PLV456jgJPdY", "language": "401", "code": "// Authentication failed or the Salesforce session is unavailable.\n" }, { "id": "OX_XtxNdtJONiiDvHrUSh", "language": "404", "code": "// Record not found.\n" }, { "id": "kl_lC-BtnY6z8byv9W3yb", "language": "429", "code": "// Salesforce limit exceeded.\n" }, { "id": "je06rbJpyrs9bbjpyYv77", "language": "500", "code": "// Unexpected or upstream failure.\n" } ], "selectedLanguageId": "LIASAoYxCYTa3vFWaFRB-" } }, "children": [ { "text": "" } ] }