This API allows you to send the agreement document for manual signatures.

API

Signature

sendForSignature

webService static Boolean sendForSignature(Id primaryContactID, List emailCc, List emailBcc, List emailAdditionalTo, Id emailTemplateId, Id agreementId, List attachmentIds)
Request Parameters
NameTypeDescriptionRequired
primaryContactIDIDThe id of the primary contact.Yes
emailCclist The email ids of the recipients you need to CC in the email.Optional
emailBcclist The email ids of the recipients you need to BCC in the email.Optional
emailAdditionalTolist The email ids of the recipients you need to send the email.Yes
emailTemplateIdIDThe id of the email template that you need to use to send the email.Yes
agreementIdIDThe id of the document that is to be signed.Yes
attachmentIdslist The ids of the documents that are to be signed.Yes
Response Parameter
NameTypeDescription

result

BooleanIndicates whether the agreement was sent for signatures successfully.

Code Sample

List<String> addto = new list<String>{'test1@abc.com','test2@abc.com','test3@abc.com','test4@apttus.com'};
List<String> cc = new list<String>{'test5@abc.com','test6@abc.com','test7@abc.com','test8@abc.com'};
List<String> bcc = new list<String>{'test9@abc.com','test10@abc.com','test11@abc.com','test12@abc.com'};
List<id> attmentids = new list<String>{'00P0S000002nzJg','00P0S000002nzJb'};
id primaryContactID = '0030S00000MxYfb';
id emailTemplateId = '00XA0000000h9eQ';
id agreementId = 'a070S000002I3I4';
Boolean response = apttus.AgreementWebService.sendForSignature(primaryContactID,cc,bcc,addto,emailTemplateId,agreementId,attmentids);
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 Apttus 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>00D0S0000000Pa8!ARUAQMbFkHvnVLwOoAiCDHaWEz0Bkjf6uEcSsGd4853e7wLfvv88oUmBtR0xy2BYEgdcP6IrMA1b9qJ7N3uDyPC31sNPlfjs</agr:sessionId>
      </agr:SessionHeader>
   </soapenv:Header>
   <soapenv:Body>
      <agr:sendForSignature>
         <agr:primaryContactID>0030S00000MxYfbQAF</agr:primaryContactID>
         <agr:emailCc>test1@abc.com</agr:emailCc>
         <agr:emailCc>test2@abc.com</agr:emailCc>
         <agr:emailBcc>test3@abc.com</agr:emailBcc>
         <agr:emailBcc>test4@abc.com</agr:emailBcc>
         <agr:emailAdditionalTo>test5@abc.com</agr:emailAdditionalTo>
         <agr:emailAdditionalTo>test6@abc.com</agr:emailAdditionalTo>
         <agr:emailTemplateId>00XA0000000h9eQ</agr:emailTemplateId>
         <agr:agreementId>a070S000002I4J4QAK</agr:agreementId>
         <agr:attachmentIds>a1z0S000000u1hqQAA</agr:attachmentIds>
      </agr:sendForSignature>
   </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/AgreementWebService">
   <soapenv:Body>
      <sendForSignatureResponse>
         <result>true</result>
      </sendForSignatureResponse>
   </soapenv:Body>
</soapenv:Envelope>
XML