Aller au contenu principal

Exemples d'Entrée

Ces exemples montrent la structure des objets JavaScript pour les types d'entrée courants. Pour les détails complets des champs (types, obligatoires/optionnels, valeurs par défaut), voir les pages individuelles de référence des entrées.

Paramètres d'Envoi de Document - Entrée​

Voir : DocumentSendSettingsInput · mutation send

const documentSendInput = {
  title: "Contract Agreement",
  groupId: "Z3JwMTIzNDU2",
  templateId: "dHBsMTIzNDU2",
  recipients: [
    {
      id: "cm9sZTEyMzQ1Ng==",
      firstName: "John",
      lastName: "Doe",
      email: "john.doe@example.com",
      role: "Signer",
      roleId: "cm9sZTEyMzQ1Ng==",
      order: 1,
      signerIndex: 1,
      experience: "ZXhwMTIzNDU2",
      channel: "EMAIL",
      timeZone: "Europe/London"
    }
  ],
  participantFields: [
    {
      id: "ZWxlbWVudC0x",
      value: "John Doe",
      signer: 1,
      elementType: "TEXT"
    }
  ],
  senderFields: [
    {
      id: "ZWxlbWVudC0y",
      value: "Company Name",
      elementType: "TEXT"
    }
  ],
  documentCCEmail: ["manager@example.com"],
  allowCopying: false,
  allowPrinting: false,
  sequentialSigning: true,
  suppressEmails: false
};

Entrée de Création de Modèle​

Voir : templateCreateInput · mutation createTemplate

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

Entrée de Création d'Élément de Modèle​

Voir : templateElementCreateInput · mutation createTemplateElement

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"
};

Entrée de Création de Contact​

Voir : contactCreateInput · mutation createContact

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

Entrée de Création de Groupe de Contacts​

Voir : contactGroupCreateInput · mutation createContactGroup

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

Entrée de Création de Groupe​

Voir : groupCreateInput · mutation createGroup

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

Entrée de Création d'Expérience​

Voir : experienceCreateInput · mutation createExperience

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
};

Entrée de Création de Planning​

Voir : scheduleCreateInput · mutation createSchedule

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

Entrée de Création d'Élément de Planning​

Voir : scheduleItemCreateInput · mutation createScheduleItem

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
};

Entrée Destinataire​

Voir : RecipientInput

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
};

Entrée d'Envoi par Lots​

Voir : SendBatchInput · mutation sendBatch

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

Entrée de Création de Stockage Cloud​

Voir : cloudStoreCreateInput · mutation createCloudStore

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

Entrée de Création de Webhook​

Voir : WebhookCreateInput · mutation createWebhook

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

Entrée de Mise à Jour Utilisateur​

Voir : userUpdateInput · mutation updateUser

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

Entrée de Mise à Jour de Groupe​

Voir : groupUpdateInput · mutation updateGroup

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@example.com"],
  autoTag: true
};

Entrée de Création de Rôle de Modèle​

Voir : templateRoleCreateInput · mutation createTemplateRole

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

Entrée de Création d'Invitation​

Voir : invitationCreateInput · mutation createInvitation

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

Entrée d'Arrêt de Données​

Voir : DataStopInput · mutation createDataStop

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

Entrée de Création de Ticket Support​

Voir : supportTicketCreateInput · mutation createSupportTicket

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."
};

Entrée de Création de Retour d'Information​

Voir : feedbackCreateInput · mutation createFeedback

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

Entrée de Marquage Comme Terminé​

Voir : markAsCompleteInput · mutation markAsComplete

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

Entrée de Copie de Modèle​

Voir : templateCopyInput · mutation copyTemplate

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

Entrée de Mise à Jour Destinataire​

Voir : RecipientUpdateInput · mutation updateRecipient

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

Export This Article

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