Skip to main content

Experiences

An Experience controls everything the signer sees and receives when they're sent a document — the emails, the signing page, the branding, and the behaviour. Every group has at least one Experience (the default), and you can create multiple Experiences for different use cases.

What an Experience controls​

Emails​

  • Subject lines for invitation, reminder, completion, and rejection emails
  • Email header text and sub-header text
  • Additional email body text
  • Email logo (uploaded separately via the upload query)
  • Whether to attach a draft PDF to the invitation email

Signing page​

  • Branding colours (background, borders, buttons, text)
  • Logo and logo dimensions
  • Header and body text shown to the signer
  • Agreement tick boxes (signingPageAgreeTicks) — require the signer to agree to terms before signing
  • Whether the signer can reject the document (signingPageRejectButton)
  • Text shown after signing (signingPageText)
  • Session timeout (signingSessionTime)

Signature options​

  • Signature input methods: draw with mouse (signatureMouse), type (signatureType), upload image (signatureUpload)
  • Whether to allow reuse of a previous signature (allowSignatureReuse)
  • What to append to the signature: name format (signatureAppend), date/IP format (signatureAppendExtra)
  • Pen diameter for drawn signatures
  • Whether to include a digital certificate (signatureCertificate)

Behaviour​

  • emailSendSequence — send to all recipients at once (0) or in sequence (1)
  • canReassign — allow the signer to reassign the document to someone else
  • forwarding — allow the signer to forward the document
  • postSignEmail — send a confirmation email after signing
  • postSignAttach — attach the signed PDF to the confirmation email
  • Witnessing requirements (witnessingRequiresSignerSMS, witnessingRequiresWitnessSMS)

Language​

  • language — the language code for the signer's UI (e.g. en, fr, de). This controls the language of system-generated text on the signing page and in emails.

When to use multiple Experiences​

  • Different languages — create an Experience per language for international signers
  • Different branding — white-label the signing experience for different clients or products
  • Different signing rules — one Experience requires agreement ticks, another doesn't
  • Internal vs external — a streamlined Experience for internal staff, a more formal one for external clients

Using Experiences with the API​

Set the default​

One Experience per group is marked as defaultExperience: true. Documents sent without specifying an Experience use this one.

Specify when sending​

Pass an experienceId in the send mutation to override the default:

mutation {
  send(input: {
    groupId: "Z3JwMTIzNDU2"
    templateId: "dHBsMTIzNDU2"
    experienceId: "ZXhwMTIzNDU2"
    title: "Contract - French"
    recipients: [
      { firstName: "Marie", lastName: "Dupont", email: "marie@example.com", role: "Signer" }
    ]
  })
}

CRUD operations​

Export This Article

Save a copy of this page as PDF or plain text.