Experience
An Experience defines how a signing session looks and behaves for recipients. Each Group has a default Experience, and you can create additional ones for different languages, branding, or consent requirements.
Experiences control email content, signing page appearance, signature options, and witness settings.
Fields
Identity
| Field | Type | Description |
|---|---|---|
id | ID | Unique identifier |
name | String | Name (must be unique within the group, >2 chars) |
defaultExperience | Boolean | Whether this is the group's default experience |
language | String | Language code for the signing session |
created | AWSDateTime | When the experience was created |
modified | AWSDateTime | When the experience was last modified |
Signing Page
| Field | Type | Description |
|---|---|---|
header | String | Page header text |
text1 | String | Custom text block 1 |
text2 | String | Custom text block 2 |
text3 | String | Custom text block 3 |
signingPageText | String | Text on the PDF download page (after signing) |
signingPageAgreeTicks | AWSJSON | Array of agreement checkbox items |
signingPageRejectButton | Boolean | Show reject button |
signingSessionTime | Int | Session timeout duration |
signatureDoneText | String | Text shown after signing completes |
Signature Options
| Field | Type | Description |
|---|---|---|
signatureMouse | Boolean | Allow draw-to-sign |
signatureType | Boolean | Allow type-to-sign |
signatureUpload | Boolean | Allow upload signature image |
signatureCertificate | Boolean | Enable certificate-based signing |
signatureCertifiedType | Int | Certification level (4 = certification) |
allowSignatureReuse | Boolean | Allow reuse of previous signature |
signatureAppend | Int | Name format on signature (0=none, 1=First initial Last, 2=First initial Last + email) |
signatureAppendDate | String | Date format appended to signature |
signatureAppendExtra | String | Extra tag format (1=date, 2=date+IP, 3=IP, 4=time+date+TZ) |
penDiameter | Int | Pen thickness for draw-to-sign |
typedSignatureFixedSize | Int | Fixed font size for typed signatures |
Email Settings
| Field | Type | Description |
|---|---|---|
defaultSubject | String | Default email subject line |
defaultReminderSubject | String | Default reminder subject |
emailHeader | String | Email header text |
emailSubHeader | String | Email sub-heading for signers |
emailExtra | String | Additional email content |
emailLogo | String | Email logo filename |
emailSendSequence | Int | Send sequence (0=all at once, 1=sequential) |
emailRejectedToSignersSubject | String | Subject for rejection emails |
emailSignedToSignersSubject | String | Subject for completion emails |
finalSignerEmailSubHeader | String | Sub-heading for final signer email |
finalSignerEmailText | String | Body text for final signer email |
rejectedEmailSubheader | String | Sub-heading for rejection emails |
senderName | String | Sender name on emails |
attachDraft | Boolean | Attach draft PDF to first email and reminders |
postSignAttach | Boolean | Attach signed PDF to completion email |
postSignEmail | Boolean | Send completion email |
Branding
| Field | Type | Description |
|---|---|---|
logoName | String | Logo filename |
logoImageHeight | Int | Logo height on signing page |
logoImageWidth | Int | Logo width on signing page |
backgroundColour | String | Page background colour |
bordersColour | String | Border colour |
buttonBarBackgroundColour | String | Button bar background |
buttonBackgroundColour | String | Button background |
buttonBorderColour | String | Button border |
buttonFontColour | String | Button text colour |
textBackgroundColour | String | Text area background |
textFontColour | String | Text colour |
footerTextColour | String | Footer text colour |
Recipient Options
| Field | Type | Description |
|---|---|---|
canReassign | Boolean | Signer can reassign to someone else |
canSignPageDownload | Boolean | Signer can download draft PDF |
forwarding | Boolean | Allow forwarding |
Witnessing
| Field | Type | Description |
|---|---|---|
witnessSameDevice | Boolean | Witness must use same device as signer |
witnessingRequiresSignerSMS | Boolean | Signer SMS verification for witnessing |
witnessingRequiresWitnessSMS | Boolean | Witness SMS verification |
Query
query GetExperience($id: ID!) {
experience(id: $id) {
id
name
language
defaultExperience
defaultSubject
}
}
Experiences are also accessed via Group.experienceConnection.
Example
Loading all experiences for a group (based on the Legalesign Console app):
query GetGroupExperiences {
group(id: "Z3JwbGVnYWxlc2lnbxRldg==") {
experienceConnection {
experiences {
id
name
defaultExperience
language
}
}
}
}
Related
- Experiences explained — what Experiences are and when to use multiple
- Group — the group this experience belongs to
- Recipient — recipients use an experience during signing
- Template — templates reference experiences via roles
- Query Examples — basic experience query
- Complex Query Examples — experiences in group context
- Mutation Examples — create, update, delete experiences
- Input Examples — experience input structure