Conga Sign Parameters

The native Send with Conga Sign button's behavior and functionality is customizable with Conga Sign parameters.

There is a separate set of integration parameters when using Conga Sign with Composer. For more information, see Conga Sign Integration Parameters. Also, note that parameters are case-sensitive.

Parameters

• authRequired

  • Allows Administrators to control whether their Users can disable SMS Authentication in the Create Transaction UI. 

  • When enabled, Senders are unable to change the Authentication Type for a signer to "Standard", the "Standard" option will not be available in the Auth dropdown. Senders can still modify a signer's phone number by clicking the authentication dropdown and selecting the SMS option. 

  • The following prerequisite parameters are required for this parameter:
    &recipient[1-10]
    &recipientrole[1-10]
    &recipientlanguage[1-10]
    &recipientauth[1-10]=SMS
    &recipientmobile[1-10]

    Example

    authRequired=true

    CODE

• businessUnit

  • A string that defines a specific Business Unit to select for a Conga Sign Transaction.

  • The parameter value must be the API name of one active Business Unit. You can use this parameter once in a transaction to designate a singular Business Unit.

    Example

    businessUnit=Global_Tech_Inc

    CODE

• documentId

  • A ContentDocument ID that automatically selects a document on the screen.
  • The Id referenced here can be a document that is attached to the parent object, or attached to a different object. 

  • Intended for individual document Ids only, not to be used in conjunction with documentIds. Buttons that contain both documentId and documentIds will result in error.

    Example

    &documentId=0696A000005bXNn

    CODE

• documentIds

  • A selection of document Ids that automatically selects multiple documents on the screen. 
  • The Ids referenced here can be documents that are attached to the parent object, or attached to different objects. 

  • This parameter must be used independently of the documentId parameter. Buttons that contain both documentId and documentIds will result in error.

  • Defined Ids must be comma-delimited. 

  • Documents will appear in the Create Transaction screen in the order of the Ids applied to the parameter from left to right. 

    Example

    &documentIds=0696A000005bXNn,0531A001005bDcS

    CODE

• emailMessage

  • A string with a limit of 50000 characters.

  • Add parameter email message (string, max length 50000) that defaults the message field in the email section of the Conga Sign user interface.

    Example

    &emailMessage=Please+sign+this+document.

    CODE

• expireDays

  • A number that determines the number of days before the Transaction expires. 

  • The number must be a positive integer. 

    Example

    &expireDays=7

    CODE

• expireOn

  • A string for a datetime in UTC format.
  • It can be used with a merge field if wrapped in a TEXT() function.

  • Add parameter expires (ISO8601 date) that default the transaction expires field in the notification section.

    Example

    &expireOn={!TEXT(Object.DateTime)}

    CODE

    Example

    &expireOn=2019-07-10T14:00:00.000Z

    CODE

• expireReminder

  • A string for a datetime in UTC format.

  • Add parameter expirationReminder (ISO8601 date) that defaults the expiration reminder in the notification section.

    Example

    &expireReminder=2019-07-10T14:30:00.000Z

    CODE

• expireReminderDays

  • A number to determine the number of days before the first reminder email is sent. 

  • The number must be a positive integer.

    Example

    &expireReminderDays=2

    CODE

• emailSubject

  • A string with a limit of 1000 characters.

  • Add parameter emailSubject (string, max length 1000) that defaults the subject field in the email section.

    Example

    &emailSubject=Document+for+Signature

    CODE

• reminderDays

  • A number which is a positive integer.

  • Add parameter reminder (integer) that defaults the request reminder field in the notification section.

    Example

    &reminderDays=3

    CODE

• id

  • A string of a 15 digit or 18 digit Salesforce record id.

  • Determines the master object id for a Conga Sign transaction.

    Example

    &id=006f400000RTyAN

    CODE

• reassignAllowed

  • Allows the recipient of a Conga Sign transaction to reassign the signer of the transaction.

    Example

    &reassignAllowed=true

    CODE

• recipient[1-10]

  • A string for a Contact, Lead, or User Salesforce Id.

  • Recipients 1 through 10 to assign to the transaction. If any recipients are skipped the resulting list is squashed - i.e. if only recipients 3 and 5 are set they show up as 1 and 2 in the UI.

    Example

    &recipient1={!Opportunity.ContactId__c}&recipient2=0036A00000O33p4

    CODE

• recipient[1-10]auth

  • A string for a Contact, Lead or User Salesforce Id; SMS is the only available value
  • Assigns SMS authorization to a recipient.

  • If the recipient[1-10]mobile parameter is not designated for a recipient, Conga Sign automatically uses the mobile number on the recipient's Salesforce record (Contact, User, or Lead) to send the SMS authorization to. The Mailing Country field on the record must be configured with 2 character ISO 3166-1 alpha-2 country code (example: US Mobile number: 3038675309, country code: US).

    Example

    &recipient1={!Opportunity.ContactId__c}&recipient1Auth=SMSNote: SMS Authentication is currently available for Early Adopters only. To become an Early Adopter, contact your designated Customer Success Manager or Conga Support.

    CODE

• recipient[1-10]curl

  • • A string to determine a website that recipients can chose to be taken to after successfully completing signing.
    • With this parameter, recipients can click Continue after completing signing and are taken to the URL defined with the recipient[1-10]curl parameter.
    • If the recipient is a standard SIGNER and clicks Continue after completing signing, they are taken to the URL in the same browser tab. If the recipient is an IN_PERSON_SIGNER and clicks Continue after completing signing, they are taken to the URL in a new browser tab.

    • The format of the URL must start with either http:// or https://. The www. portion of a URL is optional.

      Example

      recipient[1-10]curl parameter values:
      http://www.conga.com
      http://conga.com
      https://www.conga.com
      https://conga.com

      CODE

• recipient[1-10]email

  • A string to determine the email address necessary to create and add a new Conga Sign Recipient to a transaction.

  • This parameter also requires the recipient[1-10]first and recipient[1-10]last parameters, or the recipient[1-10]name parameter, to successfully create and add new Conga Sign Recipients.

    

    Use the recipient[1-10]name parameter to define a new Conga Sign Recipient's full name, as opposed to using recipient[1-10]first and recipient[1-10]last to define first and last name separately. You cannot use recipient[1-10]name with recipient[1-10]first and recipient[1-10]last to define a new Conga Sign Recipient's name.
  • The parameter value must have the following email address format: <username>@<domain>.com

  • The recipient[1-10]email, recipient[1-10]first, recipient[1-10]last, and recipient[1-10]name parameters are used to specifically create a new Conga Sign Recipient that does not already exist as a Contact, User, or Lead record in Salesforce.

  • Creating and adding a new Conga Sign Recipient to a transaction does not create a Contact, Lead, or User record in Salesforce. It creates a Conga Sign Recipient (custom object) record specific to that transaction only. New Conga Sign Recipients created with Conga Sign parameters cannot be added or re-used in other transactions.

    

    Use the recipient[1-10] parameter to add existing Contact, Leads, and Users as Conga Sign Recipients, instead of creating new Conga Sign Recipients.

• recipient[1-10]first

  • A string to determine the first name necessary to create and add a new Conga Sign Recipient to a transaction.

  • This parameter also requires the recipient[1-10]last and recipient[1-10]email parameters to successfully create and add a new Conga Sign Recipient.

  • The recipient[1-10]email, recipient[1-10]first, recipient[1-10]last, and recipient[1-10]name parameters are used to specifically create a new Conga Sign Recipient that does not already exist as a Contact, User, or Lead record in Salesforce.

    

    Use the recipient[1-10] parameter to add existing Contact, Leads, and Users as Conga Sign Recipients, instead of creating new Conga Sign Recipients.
  • Creating and adding a new Conga Sign Recipient to a transaction does not create a Contact, Lead, or User record in Salesforce. It creates a Conga Sign Recipient (custom object) record specific to that transaction only. New Conga Sign Recipients created with Conga Sign parameters cannot be added or re-used in other transactions.

• recipient[1-10]language

  • A string for a Contact, Lead or User Salesforce Id; either de, fr, en-US, es, pt-PT, pt-BR, it, el, nl-NL, hr, pl, uk, ro, ka, ru or sh
  • Assigns a language to a specific recipient.
  • The following languages are supported:
    • German: de
    • French: fr
    • English (US): en-US
    • Portuguese (Portual): pt-PT
    • Portuguese (Brazil): pt-BR
    • Italian: it
    • Greek: el
    • Dutch: nl-NL

    • Croatian - hr

    • Polish - pl

    • Ukrainian - uk

    • Romanian - ro

    • Georgian - ka

    • Russian - ru

    • Serbian - sh

      Example

      &recipient1={!Opportunity.ContactId__c}&recipient1language=fr

      CODE

• recipient[1-10]last

  • A string to determine the last name necessary to create and add a new Conga Sign Recipient to a transaction.

  • This parameter also requires the recipient[1-10]first parameter and recipient[1-10]email parameters to successfully create and add a new Conga Sign Recipient.

  • The recipient[1-10]email, recipient[1-10]first, recipient[1-10]last, and recipient[1-10]name parameters are used to specifically create a new Conga Sign Recipient that does not already exist as a Contact, User, or Lead record in Salesforce.

    

    Use the recipient[1-10] parameter to add existing Contact, Leads, and Users as Conga Sign Recipients, instead of creating new Conga Sign Recipients.
  • Creating and adding a new Conga Sign Recipient to a transaction does not create a Contact, Lead, or User record in Salesforce. It creates a Conga Sign Recipient (custom object) record specific to that transaction only. New Conga Sign Recipients created with Conga Sign parameters cannot be added or re-used in other transactions.

• recipient[1-10]name

  • A string to determine the full name (both first and last name) necessary to create and add a new Conga Sign Recipient to a transaction.

    

    Use a space or + symbol to separate the first and last name for this parameter value.

  • This parameter requires the recipient[1-10]email parameter to successfully create and add a new Conga Sign Recipient.

    

    Use the recipient[1-10]name parameter to define a new Conga Sign Recipient's full name, as opposed to using recipient[1-10]first and recipient[1-10]last to define first and last name separately. You cannot use recipient[1-10]name with recipient[1-10]first and recipient[1-10]last to define a new Conga Sign Recipient's name.

  • The recipient[1-10]email, recipient[1-10]name, recipient[1-10]first, and recipient[1-10]last parameters are used to specifically create a new Conga Sign Recipient that does not already exist as a Contact, User, or Lead record in Salesforce.

    

    Use the recipient[1-10] parameter to add existing Contact, Leads, and Users as Conga Sign Recipients, instead of creating new Conga Sign Recipients.
  • Creating and adding a new Conga Sign Recipient to a transaction does not create a Contact, Lead, or User record in Salesforce. It creates a Conga Sign Recipient (custom object) record specific to that transaction only. New Conga Sign Recipients created with Conga Sign parameters cannot be added or re-used in other transactions.

• recipient[1-10]role

  • A string for a Contact, Lead or User Salesforce Id; either IN_PERSON_SIGNER, SIGNER, or CC

  • Assigns a role to a specific recipient.

    Example

    &recipient1={!Opportunity.ContactId__c}&recipient1role=SIGNER

    CODE

• recipient[1-10]mobile

  • A string for a Contact, Lead, or User Salesforce Id that assigns a mobile number to a specific recipient for SMS Authentication.
  • The string must be all numeric and include the country code (example: US mobile number: 13038675309).
  • If the recipient[1-10]mobile parameter is not designated for a recipient, Conga Sign automatically uses the mobile number on the recipient's Salesforce record (Contact, User, or Lead) to send the SMS authorization to. There are two acceptable format options for phone numbers in the Mobile field.
    1. Full E.164 format, which includes the '+' and the country code (ex: US mobile number: +13036669999)
    2. The mobile number does not include the '+' and country code, but the Mailing Country in the Address Information section for the recipient is configured with the 2 character ISO 3166-1 alpha-2 country code. (ex: US mobile number: 3035171753, country code: US).

  • Requires recipient to have the recipient[1-10]auth=SMS parameter.

    Example

    &recipient1={!Opportunity.ContactId__c}&recipient1Auth=SMS&recipient1Mobile=13038675309

    CODE

• reminderFrequencyDays

  • A number to determine the frequency with which Conga Sign sends reminder emails to recipients.

  • The value must be numeric and can only be between the values of 1-120.
    

    Example

    &reminderFrequencyDays=4

    CODE

• routingType

  • A string for routing type; either PARALLEL or SERIAL

  • If set to PARALLEL, all recipients are routed at the same level (default behavior). If set to SERIAL, recipients are routed based upon their defined routing order. Example: CSRecipient1, CSRecipient2, CSRecipient3.

  • If you want CC role(s) to receive emails at the beginning and end of the transaction, place them at the beginning of the recipients list. If you want CC role(s) to receive an email only after a document has been signed, place them at the end of the recipients list.

    Example

    &routingType=SERIAL

    CODE

• senderReturnUrl

  • A string to determine a page that the sender is returned to after successfully sending a transaction.
  • Add senderReturnUrl = http/https site or relative url.

  • By using the below example, you are redirected to the Conga Support website after successfully sending a transaction.

    Example

    {!URLFOR($Site.Prefix)}/apex/APXT_CongaSign__apxt_sendForSignature?id={!Opportunity.Id}&senderReturnUrl=https://support.conga.com

    CODE

  • By using the below example, you are redirected to the Account record associated with the Opportunity record after successfully sending a transaction.

    Example

    {!URLFOR($Site.Prefix)}/apex/APXT_CongaSign__apxt_sendForSignature?id={!Opportunity.Id}&senderReturnUrl=/{!Opportunity.AccountId}

    CODE

• sendOnBehalfOfName

  • A string to identify the Name of the intended recipient you are sending a transaction on behalf of.

    Example

    &sendonbehalfofname=First+Last

    CODE

• sendOnBehalfOfEmail

  • A string to identify the Email of the intended recipient you are sending a transaction on behalf of.

    Example

    &sendonbehalfofemail=fLast@conga.com

    CODE

• syncDocsToParent

  • A string to integrate with Conga CLM, allows you to determine if you would like the documents in a transaction to be synced to the record the button was launched from. 
  • When syncDocsToParent is set to false, the original and final documents will only be synced to the transaction record in Salesforce. 

  • Signer attachments will only sync back to the transaction record in Salesforce.

    Example

    &syncDocsToParent=false

    CODE

• syncFinalDocAsNewContentDoc 

  • A string to integrate with Conga CLM, allows you to determine if you would like the final document to come as a separate content document. 

  • The Final Documents Sync Status field will be populated with a note of SUCCESS once the final documents are written back into Salesforce if the parameter is set to true.

    Example

    &syncFinalDocAsNewContentDoc=true

    CODE