experienceCreateInput

Create a new Experience for a group. See the Experience type for field descriptions.

Required Fields

Field	Type	Description
groupId	ID!	Group to create the experience in
name	String!	Unique name within the group

Optional Fields

See the Experience type for detailed field descriptions.

Branding & Colours

Field	Type	Default	Description
header	String	—	Page header text
backgroundColour	String	—	Page background colour
bordersColour	String	—	Border colour
buttonBarBackgroundColour	String	—	Button bar background
buttonBackgroundColour	String	—	Button background
buttonBorderColour	String	—	Button border colour
buttonFontColour	String	—	Button font colour
footerTextColour	String	—	Footer text colour
textBackgroundColour	String	—	Text area background
textFontColour	String	—	Text font colour
logoName	String	—	Logo file name
logoImageHeight	Int	—	Logo height in pixels
logoImageWidth	Int	—	Logo width in pixels

Email Settings

Field	Type	Default	Description
defaultSubject	String	—	Default email subject
defaultReminderSubject	String	—	Reminder email subject
emailExtra	String	—	Extra email content
emailHeader	String	—	Email header text
emailLogo	String	—	Pre-uploaded email logo key
emailRejectedToSignersSubject	String	—	Rejection email subject
emailSendSequence	Int	—	Email send sequence
emailSignedToSignersSubject	String	—	Signed notification subject
emailSubHeader	String	—	Email sub-header
finalSignerEmailSubHeader	String	—	Final signer email sub-header
finalSignerEmailText	String	—	Final signer email text
rejectedEmailSubheader	String	—	Rejection email sub-header
senderName	String	—	Sender display name

Signing Page

Field	Type	Default	Description
text1	String	—	Signing page text block 1
text2	String	—	Signing page text block 2
text3	String	—	Signing page text block 3
signingPageText	String	—	Signing page instructions
signingPageAgreeTicks	AWSJSON	—	Agreement tick configuration
signingPageRejectButton	Boolean	—	Show reject button
signingSessionTime	Int	—	Session timeout in minutes
language	String	—	Signing page language code
forwarding	Boolean	—	Allow recipient forwarding
canReassign	Boolean	—	Allow recipient reassignment
canSignPageDownload	Boolean	—	Allow download from signing page

Signature Settings

Field	Type	Default	Description
allowSignatureReuse	Boolean	—	Allow reuse of saved signatures
signatureMouse	Boolean	—	Allow mouse/draw signatures
signatureType	Boolean	—	Allow typed signatures
signatureUpload	Boolean	—	Allow uploaded signatures
signatureCertificate	Boolean	—	Include signature certificate
signatureCertifiedType	Int	4	Certificate type
signatureAppend	Int	—	Signature append mode
signatureAppendDate	String	—	Date format for appended signatures
signatureAppendExtra	String	—	Extra text appended to signatures
signatureDoneText	String	—	Text shown after signing
penDiameter	Int	2	Drawing pen diameter
typedSignatureFixedSize	Int	—	Fixed size for typed signatures

Post-signing & Witness

Field	Type	Default	Description
attachDraft	Boolean	—	Attach draft to email
postSignAttach	Boolean	—	Attach completed document
postSignEmail	Boolean	—	Send post-signing email
defaultExperience	Boolean	false	Set as group default
witnessSameDevice	Boolean	false	Require witness on same device
witnessingRequiresSignerSMS	Boolean	false	Require signer SMS for witnessing
witnessingRequiresWitnessSMS	Boolean	false	Require witness SMS

Example

mutation CreateExperience {
  createExperience(input: {
    groupId: "Z3JwLTE="
    name: "French Signing"
    language: "fr"
    defaultSubject: "Document à signer"
  })
}