Recalling Bulk Approval Requests
With this API, you can cancel or recall previously submitted bulk approval requests. This API accepts the object type and the object ID of the context object as input parameters. You can also add comments to your cancel requests.
If you submit previously submitted or approved approvals as part of bulk cancel requests, all the approvals are canceled.
The cancelApprovalsBulk API supports up to 50 context object records. Beyond this limit, Salesforce throws a SOQL error.
API |
Signature |
---|---|
cancelApprovalsBulk |
webService static Boolean cancelApprovalsBulk(List ctxObjParams) |
Request Parameters | |||
---|---|---|---|
Name |
Type |
Required? |
Description |
approvalParams | Object |
Yes |
Object containing all the approval parameters |
approvalParams | |||
---|---|---|---|
Name |
Type |
Required? |
Description |
approvalObjectId | ID |
Yes |
ID of the approval context object. |
approvalObjectType | String |
Yes |
Type of the approval context object. |
approvalCommentsObject | Object |
No |
The approval comment object |
Response Parameter | ||
---|---|---|
Name |
Type |
Description |
result | Boolean |
Returns true if the API is executed successfully. |
Integration Details
Use the following information in your integrations with Conga Approvals API. Refer to Integrating Conga with External Systems to get started.
API Prerequisites
None.