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:
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);
CODE
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.