Canceling Approvals with Comments

This API cancels the entire approval process associated with the context object with comments. Currently, assigned approvers will be notified via email. This API accepts the object type, object ID, and comments of the approval request as input parameters.

API	Signature
*cancelApprovalsWithComments*	webService static Boolean cancelApprovalsWithComments(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	Object	Yes	The cancellation comments object.

Response Parameter
Name	Type	Description
result	Boolean	Returns true if the approvals are canceled successfully.

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>00D56000000JOmT!ARoAQCjZ0PU3esec_U3PL7gNVcNqMxI1VCFQxb0c1RvWhcxMezEtAxTwV2j0k8q_yBfjWwpKk7AUKMrMlSQ_DMtojejufhts</tes:sessionId>
      </app:SessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <app:cancelApprovalsWithComments>
         <app:sObjectType>Apttus__APTS_Agreement__c</app:sObjectType>
         <app:sObjectId>a0156000003ZhmpAAC</app:sObjectId>
         <app:comments>CancellationComments</app:comments>
      </app:cancelApprovalsWithComments>
   </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>true</result>
      </cancelApprovalsWithCommentsResponse>
   </soapenv:Body>
</soapenv:Envelope>

XML