Input Examples

Document Send Settings Input

const documentSendInput = {
  title: "Contract Agreement",
  groupId: "group-123",
  templateId: "template-456",
  recipients: [
    {
      id: "recipient-1",
      firstName: "John",
      lastName: "Doe",
      email: "john.doe@example.com",
      role: "Signer",
      order: 1,
      experience: "experience-789",
      channel: "EMAIL"
    }
  ],
  participantFields: [
    {
      id: "field-1",
      value: "John Doe",
      signer: 1,
      elementType: "TEXT"
    }
  ],
  senderFields: [
    {
      id: "field-2",
      value: "Company Name",
      elementType: "TEXT"
    }
  ],
  documentCCEmail: ["manager@example.com"],
  allowCopying: false,
  allowPrinting: false,
  sequentialSigning: true,
  suppressEmails: false
};

Template Create Input

const templateCreateInput = {
  groupId: "group-123",
  title: "Employment Contract Template"
};

Template Element Create Input

const templateElementInput = {
  templateId: "template-456",
  elementType: "SIGNATURE",
  ax: 100.0,
  ay: 200.0,
  bx: 300.0,
  by: 250.0,
  page: 1,
  label: "Employee Signature",
  optional: false,
  signer: 1,
  role: "Signer"
};

Contact Create Input

const contactCreateInput = {
  groupId: "group-123",
  firstName: "Jane",
  lastName: "Smith",
  email: "jane.smith@example.com",
  phoneNumber: "+1234567890"
};

Contact Group Create Input

const contactGroupCreateInput = {
  groupId: "group-123",
  name: "Finance Team",
  colour: "#FF5733"
};

Group Create Input

const groupCreateInput = {
  organisationId: "org-123",
  name: "Sales Department",
  apiIntegration: false,
  addExampleTemplate: true
};

Experience Create Input

const experienceCreateInput = {
  groupId: "group-123",
  name: "Standard Signing Experience",
  header: "Please sign this document",
  text1: "Welcome to our signing process",
  text2: "Please review the document carefully",
  text3: "Click sign when ready",
  allowSignatureReuse: true,
  attachDraft: false,
  backgroundColour: "#FFFFFF",
  buttonBackgroundColour: "#007BFF",
  buttonFontColour: "#FFFFFF",
  canReassign: false,
  defaultExperience: true,
  defaultSubject: "Document ready for signature",
  language: "en",
  signatureMouse: true,
  signatureType: true,
  signatureUpload: true
};

Schedule Create Input

const scheduleCreateInput = {
  groupId: "group-123",
  name: "Standard Reminder Schedule",
  default: true
};

Schedule Item Create Input

const scheduleItemCreateInput = {
  scheduleId: "schedule-123",
  daysAfter: 3,
  frequency: 7,
  subject: "Reminder: Document awaiting signature",
  message: "Please sign the document at your earliest convenience.",
  when: 2, // If document not completed
  timeOfDay: "09:00:00",
  skipWeekend: true
};

Recipient Input

const recipientInput = {
  id: "recipient-1",
  firstName: "Alice",
  lastName: "Johnson",
  email: "alice.johnson@example.com",
  phoneNumber: "+1987654321",
  role: "Signer",
  order: 1,
  signerIndex: 1,
  experience: "experience-789",
  timeZone: "America/New_York",
  channel: "EMAIL",
  skipped: false
};

Batch Send Input

const batchSendInput = {
  batchName: "Monthly Contracts Batch",
  groupId: "group-123",
  enforceOrder: false,
  notifySender: true,
  notifySenderAttach: true,
  notifyParticipants: true,
  notifyParticipantsAttach: false
};

Cloud Store Create Input

const cloudStoreCreateInput = {
  organisationId: "org-123",
  groupId: "group-123",
  location: "SHAREPOINT",
  connection: {
    root: "https://company.sharepoint.com",
    username: "service@company.com",
    password: "password123",
    folder: "/Documents/Signed"
  },
  contactEmail: "admin@company.com"
};

Webhook Create Input

const webhookCreateInput = {
  url: "https://api.company.com/webhooks/legalesign",
  event: "DOCUMENTS_COMPLETED",
  enabled: true,
  groupId: "group-123"
};

User Update Input

const userUpdateInput = {
  userId: "user-123",
  timeZone: "Europe/London",
  companyName: "Acme Corporation",
  companySize: 50,
  companyRole: "Manager",
  companyType: "Technology",
  phoneNumber: "+44123456789",
  firstName: "Robert",
  lastName: "Brown"
};

Group Update Input

const groupUpdateInput = {
  groupId: "group-123",
  groupName: "Updated Sales Department",
  publicName: "Sales Team",
  attachmentRetention: 365,
  pdfRetention: 2555, // 7 years
  retention: 1825, // 5 years
  textRetention: 365,
  certifyDocuments: true,
  stopPDFPrinting: false,
  stopPDFCopying: false,
  appendAuditLog: true,
  sequentialSend: false,
  groupCCEmail: ["compliance@company.com"],
  autoTag: true
};

Template Role Create Input

const templateRoleCreateInput = {
  templateId: "template-456",
  name: "Primary Signer",
  signerIndex: 1,
  ordinal: 1,
  experience: "experience-789",
  roleType: "SIGNER"
};

Invitation Create Input

const invitationCreateInput = {
  groupId: "group-123",
  email: "newuser@company.com",
  permission: "EDIT",
  suppressEmail: false
};

Data Stop Input

const dataStopInput = {
  organisationId: "org-123",
  email: "user@company.com"
};

Support Ticket Create Input

const supportTicketCreateInput = {
  organisationOrGroupId: "org-123",
  subject: "Unable to send documents",
  description: "I'm experiencing issues when trying to send documents for signature. The process fails at the recipient selection stage."
};

Feedback Create Input

const feedbackCreateInput = {
  description: "The new template editor is much easier to use!",
  feedbackType: "SUGGESTION",
  contactMe: true,
  joinBeta: false,
  email: "user@company.com"
};

Mark As Complete Input

const markAsCompleteInput = {
  documentId: "document-789",
  isUploaded: true,
  declarationText: "I confirm this document has been completed offline",
  comment: "Signed in person during meeting"
};

Template Copy Input

const templateCopyInput = {
  templateId: "template-456",
  newTitle: "Copy of Employment Contract Template",
  copyFields: true,
  groupId: "group-123"
};

Recipient Update Input

const recipientUpdateInput = {
  recipientId: "recipient-789",
  firstName: "Updated First Name",
  lastName: "Updated Last Name",
  email: "newemail@company.com",
  phoneNumber: "+1555123456",
  expiryDate: "2024-12-31T23:59:59Z",
  timezone: "America/Los_Angeles",
  emailPreviousIfReplaced: true,
  ifNewRecipientReSendNotification: true,
  ifNewRecipientEmailMessage: "Your signing details have been updated"
};