Canceling Approvals with Comments Asynchronously

This API cancels the entire approval process associated with the context object asynchronously in the background and lets the user include comments. Currently, assigned approvers will be notified via email as well as an email to the user cancelling that all requests associated with the agreement have been cancelled. This API accepts the object type and the object ID of the approval request, as well as comments for recalling approvals as input parameters.

API	Signature
cancelApprovalsWithCommentsAsync	WebService static Boolean cancelApprovalsWithCommentsAsync(String sObjectType, ID sObjectId, String comments)

Request Parameters
Name	Type	Required?	Description
sObjectId	ID	Yes	ID of the approval context object.
sObjectType	String	Yes	Type of the approval context object.
comments	String	No	Recall comments (optional).

Response Parameter
Name	Type	Description
result	ID	Returns the ID of the submitted queueable job.

Integration Details

Use the following information in your integrations with Conga Approvals API. Refer to Integrating Conga with External Systems for information on how to get started.

API Prerequisites

None.

Response/Request XML

Example Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:app="http://soap.sforce.com/schemas/class/Apttus_Approval/ApprovalsWebService">
   <soapenv:Header>      
      <app:SessionHeader>
         <app:sessionId>00DR0000001nyVR!ARYAQNCIk5WB9S9PlmZzS2uecBjxnhB20ndYmyxseH1LEfStQi1cXAtXiDxEyd3kAbYrAXbpJmDZzVXGxrxxleE8Fmm6kqSm</app:sessionId>
      </app:SessionHeader>
      </soapenv:Header>
   <soapenv:Body>
      <app:cancelApprovalsWithCommentsAsync>
         <app:sObjectType>Apttus__APTS_Agreement__c</app:sObjectType>
         <app:sObjectId>a07R000000AiYlw</app:sObjectId>
         <app:comments>specify recall comments here</app:sObjectId>
      </app:cancelApprovalsWithCommentsAsync>
   </soapenv:Body>
</soapenv:Envelope>

XML

Example Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/schemas/class/Apttus_Approval/ApprovalsWebService">
   <soapenv:Body>
      <cancelApprovalsWithCommentsResponse>
         <result>a07R000000AiYlw</result>
      </cancelApprovalsWithCommentsResponse>
   </soapenv:Body>
</soapenv:Envelope>

XML