Data Override Rules for the CreateAndSendFromTemplates
Data override rules for the CreateEnvelopeFromTemplates schema
The table below describes the data override rules for the CreateEnvelopeFromTemplates schema.
| Section | Element | Description |
|---|---|---|
| Recipient | ID | RecipientID is an identifier that is used to correlate the Recipient instance to the RoleAssignment. It must be a positive integer and cannot be 0 (zero). |
| Recipient | UserName | If allowable per the Template specification(s), this value will override the corresponding field for any role that this Recipient is assigned to. |
| Recipient | If allowable per the Template specification(s), this value will override the corresponding field for any role that this Recipient is assigned to. | |
| Recipient | Type | This value cannot override the value specified in the Template(s) for any role that this Recipient is assigned to. |
| Recipient | AccessCode | If allowable per the Template specification(s), this value will override the corresponding field for any role that this Recipient is assigned to. If conflicting, non-null values are provided in multiple roles to which this Recipient is assigned, an override value must be provided in this structure. |
| Recipient | RequireIDLookup | If allowable per the Template specifications, this value will override the corresponding field for any role that this Recipient is assigned to. If conflicting values are provided in multiple roles to which this Recipient is assigned, the value will resolve to True if it is not specified in this structure. |
| Recipient | IDCheckConfigurationName | If allowable per the Template specification(s), this value will override the corresponding field for any role that this Recipient is assigned to. If conflicting, non-null values are provided in multiple roles to which this Recipient is assigned, an override value must be provided in this structure. |
| Recipient | SignatureInfo - SignatureName - SignatureInitials - FontStyle | If allowable per the Template specification(s), these values will override the corresponding fields for any role that this Recipient is assigned to. If conflicting, non-null values are provided in multiple roles to which this Recipient is assigned, override values must be provided in this structures. |
| Recipient | CaptiveInfo - ClientUserId | If allowable per the Template specification(s), this value will override the corresponding field for any role that this Recipient is assigned to. If conflicting, non-null values are provided in multiple roles to which this Recipient is assigned, an override value must be provided in this structure. |
| Recipient | CustomFields | If allowable per the Template specification(s), this value will override a CustomField of the same name for any role that this Recipient is assigned to. If conflicting, non-null values are provided for the same CustomField name in multiple roles to which this Recipient is assigned, an override value must be provided in this structure. |
| Recipient | RoutingOrder | If allowable per the Template specification(s), this value will override the corresponding field for any role that this Recipient is assigned to. If conflicting, non-zero values are provided in multiple roles to which this Recipient is assigned, an override value must be provided in this structure. |
| Recipient | IDCheckInformation - Input | This information cannot be pre-specified in a template, so the data must be provided in this structure. |
| Recipient | AutoNavigation | If allowable per the Template specifications, this value will override the corresponding field for any role that this Recipient is assigned to. If conflicting values are provided in multiple roles to which this Recipient is assigned, the value will resolve to True if it is not specified in this structure. |
| Recipient | Attachments | If allowable per the Template specification(s), this value will override an attachment of the same name for any role that this Recipient is assigned to. If values are provided for the same Attachment name in multiple roles to which this Recipient is assigned, an override value must be provided in this structure. |
| Recipient | Note | If allowable per the Template specification(s), this value will override the corresponding field for any role that this Recipient is assigned to. If conflicting, non-null values are provided in multiple roles to which this Recipient is assigned, an override value must be provided in this structure. |
| EnvelopeInformation | EmailBlurb | If allowable per the Template specification(s), this value will override the corresponding field if provided in a referenced Template. If conflicting, non-null values are provided in multiple referenced Templates, an override value must be provided in this structure. |
| EnvelopeInformation | Subject | If allowable per the Template specification(s), this value will override the corresponding field if provided in a referenced Template. If conflicting, non-null values are provided in multiple referenced Templates, an override value must be provided in this structure. |
| EnvelopeInformation | SigningLocation | If allowable per the Template specification(s), this value will override the corresponding field if provided in a referenced Template. If conflicting, non-null values are provided in multiple referenced Templates, an override value must be provided in this structure. |
| EnvelopeInformation | CustomFields | If allowable per the Template specification(s), this value will override a CustomField of the same name if provided in a referenced Template. If conflicting, non-null values are provided in multiple referenced Templates for the same CustomField name, an override value must be provided in this structure. |
| EnvelopeInformation | VaultingOptions | If allowable per the Template specification(s), this value will override the corresponding field if provided in a referenced Template. If conflicting, non-null values are provided in multiple referenced Templates, an override value must be provided in this structure. |
| EnvelopeInformation | AutoNavigation | If allowable per the Template specification(s), this value will override the corresponding field if provided in a referenced Template. If conflicting, non-null values are provided in multiple referenced Templates, the value will resolve to True if it is not specified in this structure. |
| EnvelopeInformation | EnvelopeIdStamping | If allowable per the Template specification(s), this value will override the corresponding field if provided in a referenced Template. If conflicting, non-null values are provided in multiple referenced Templates, the value will resolve to True if it is not specified in this structure. |
| EnvelopeInformation | AuthoritativeCopy | If allowable per the Template specification(s), this value will override the corresponding field if provided in a referenced Template. If conflicting, non-null values are provided in multiple referenced Templates, the value will resolve to True if it is not specified in this structure. |