Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

download

Canceling Approvals

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

API

Signature

cancelApprovals

webService static Boolean cancelApprovals(String sObjectType, Id sObjectId)

Request Parameters

Name

Type

Required?

Description

sObjectIdID

Yes

ID of the approval context object.

sObjectTypeString

Yes

Type of the approval context object.

Response Parameter

Name

Type

Description

resultBoolean

Returns true if the approval is canceled.

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.

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:cancelApprovals> <app:sObjectType>Apttus__APTS_Agreement__c</app:sObjectType> <app:sObjectId>a07R000000AiYlw</app:sObjectId> </app:cancelApprovals> </soapenv:Body> </soapenv:Envelope> Example Response <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/schemas/class/Apttus_Approval/ApprovalsWebService"> <soapenv:Body> <cancelApprovalsResponse> <result>true</result> </cancelApprovalsResponse> </soapenv:Body> </soapenv:Envelope>