Adding Header and Footer Text without Document Protection

This API allows you to append the given text to the header and footer for a given document.

Note:

appendToHeaderFooter does not support protection levels for FX1 documents (FX2 documents do support document protection). Document protection levels are reset when header and footer are added. To retain protection levels for FX1 documents, use appendToHeaderFooter2 instead.


API	Signature
appendToHeaderFooter	`webService static Boolean appendToHeaderFooter(Id docId, String headerText, String footerText, String sessionId, String serverUrl)`


Request Parameters
Name	Type	Description	Required?
docId	`ID`	The id of the document which will have header and footer content added to it.	Yes
headerText	`String`	The header text to be appended to the document.	Yes
footerText	`String`	The footer text to be appended to the document.	Yes
sessionId	`String`	The Salesforce session id.	Yes
serverUrl	`String`	The Salesforce server Url.	Yes


Response Parameter
Name	Type	Description
result	`Boolean`	Indicates whether the header and footer are added successfully.

Code Sample

ID docId= AttachmentId;
String headerText = 'This is Header';
String footerText = 'This is Footer'; 
String apiServerURL = System.Url.getSalesforceBaseUrl().toExternalForm() + '/services/Soap/u/50.0/' +
UserInfo.getOrganizationId();
String SessionId = sessionId; //This is the session Id.
String generatedDocId = Apttus_Proposal.MergeWebService.appendToHeaderFooter(docId, headerText, footerText, sessionId, serverUrl);

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:mer="http://soap.sforce.com/schemas/class/Apttus/MergeWebService">
    <soapenv:Header>
        <mer:sessionId>00D020000008lUh!AQYAQBDMUfqKvlqcVtqEnsqWZ3CvH_9PAn553rGgepU1CKttbRUAm4C8FFgTHrzkd6juez5FF4NEryvZ8ibJC__d7TM.vxCY</mer:sessionId>
    </soapenv:Header>
    <soapenv:Body>
        <mer:appendToHeaderFooter>
            <mer:docId>068R0000001Z56SIAS</mer:docId>
            <mer:headerText>Care Company</mer:headerText>
            <mer:footerText>Copyright 2020</mer:footerText>
            <mer:sessionId>00D020000008lUh!AQYAQBDMUfqKvlqcVtqEnsqWZ3CvH_9PAn553rGgepU1CKttbRUAm4C8FFgTHrzkd6juez5FF4NEryvZ8ibJC__d7TM.vxCY</mer:sessionId>
            <mer:serverUrl>https://testmanaged--5s20minor.my.salesforce.com/services/Soap/u/50.0/00D020000008lUh</mer:serverUrl>
        </mer:appendToHeaderFooter>
    </soapenv:Body>
</soapenv:Envelope>

Example Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <appendToHeaderFooter>
         <result>true</result>
      </appendToHeaderFooter>
   </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.

Adding Header and Footer Text without Document Protection

Integration Details

API Prerequisites

Request/Response XML

Footer Section

Explore