Activating Agreements

This API activates an agreement and deletes draft documents. This API only updates the Status Category to In Effect and the Status to Activated but does not publish the activated agreement document to multiple channels. You must call one of the following APIs to publish the document:

Prerequisite

You must ensure that the Status Category for the Agreement record is In Signatures or In Filing.


API	Signature
activateAgreement	`webService static Boolean activateAgreement(Id agreementId, List selectedDocIds, List removableDocIds)`


Request Parameters
Name	Type	Description
agreementId	`ID`	The id of the agreement.
selectedDocIds	`List<ID>`	List of fully signed document ids.
removableDocIds	`List<ID>`	List of draft document ids that can be deleted.


Response Parameter
Name	Type	Description
result	`Boolean`	Indicates whether the agreement was activated successfully.

Code Sample

Id agreementId = agreement.Id;
String[] activateDocIds = new String[1];
String[] remDocIds = new String[]{};        
Boolean response = Apttus.AgreementWebService.activateAgreement(agreementId, activateDocIds, remDocIds);

Integration Details

Use the following information in your integrations with Apttus Contract Management Web Services API. For information on how to get started, refer to Integrating Conga CLM with External Systems.

API Prerequisites

None.

Request/Response XML

Example Request

<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:agr="http://soap.sforce.com/schemas/class/Apttus/AgreementWebService">
    <soapenv:Header>
        <agr:SessionHeader>
            <agr:sessionId>00D020000008lUh!AQYAQEEW..3lVJKVa9atZ.0B6NtzfwyA.27WJEfZds4IqJX8uzm8O7.VdNoOTWwjGFxgbrF03ylztaIg6VvFl_EeKVGaQccY</agr:sessionId>
        </agr:SessionHeader>
    </soapenv:Header>
    <soapenv:Body>
        <agr:activateAgreement>
            <agr:agreementId>a07020000008w9BAAQ</agr:agreementId>
            <agr:selectedDocIds>00P02000000IYA7EAO</agr:selectedDocIds>
            <agr:removableDocIds>0002000000Cc0LAAS</agr:removableDocIds>
            <agr:removableDocIds>0760000000Cc0GAAS</agr:removableDocIds>
        </agr:activateAgreement>
    </soapenv:Body>
</soapenv:Envelope>

Example Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://soap.sforce.com/schemas/class/Apttus/AgreementWebService">
   <soapenv:Body>
      <activateAgreementResponse>
         <result>true</result>
      </activateAgreementResponse>
   </soapenv:Body>
</soapenv:Envelope>

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.