Rejects one or more pending approval records. Supply reason so the explanation travels with the decision and appears on the approval history.
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.
Channel the action came from. One of UI, Email, API, or Flow; recorded on the approval for audit. Defaults to API when omitted.
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": "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": "k9u8scTjOD66ookZBTzZx", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.nue.io/cpq/approvals:reject \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"approvalIds\": []\n }'" }, { "id": "25yBQwZF_gCFbaQBhYwHI", "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 \"approvalIds\": []\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:reject\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "32Yl6aFTa4VJrCHWQn_FS", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/cpq/approvals:reject\")\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 \"approvalIds\": []\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "2WJxt2RhueeAd7iPD4OEe", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/cpq/approvals:reject\"\n\npayload = json.dumps({\n \"approvalIds\": []\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": "k9u8scTjOD66ookZBTzZx" }, "results": { "languages": [ { "id": "qQJmIZ49YpfO104y-w2qL", "language": "200", "code": "// Approvals rejected.\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": "nPyAuG5FLds5cgVSD576j", "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": "qT9RhtBD64zm263Cd5Fgq", "language": "401", "code": "// Authentication failed or the Salesforce session is unavailable.\n" }, { "id": "aXCz-gWFxj7uHocR1ov-P", "language": "404", "code": "// Record not found.\n" }, { "id": "QUmBX4voC6JtylD45hKBh", "language": "429", "code": "// Salesforce limit exceeded.\n" }, { "id": "bk0txb2vzMNwPueCYyRP4", "language": "500", "code": "// Unexpected or upstream failure.\n" } ], "selectedLanguageId": "qQJmIZ49YpfO104y-w2qL" } }, "children": [ { "text": "" } ] }