Aller au contenu principal

Exemples de Mutations

Ces exemples montrent la syntaxe GraphQL pour chaque mutation. Pour les détails complets des champs d'entrée, consultez les pages de référence des mutations et les pages de référence des entrées.

astuce

Pour des structures d'objet d'entrée détaillées et des exemples, voir Exemples d'Entrée.

Opérations sur les Documents​

Envoyer un Document​

Voir : mutation send · DocumentSendSettingsInput

Envoie un document pour signature. Voir Entrée Paramètres d’Envoi de Document pour un exemple complet.

mutation SendDocument($input: DocumentSendSettingsInput!) {
  send(input: $input)
}

Variables d'Entrée :

{
  "input": {
    "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",
        "timeZone": "Europe/London"
      }
    ],
    "allowCopying": false,
    "allowPrinting": false,
    "sequentialSigning": true
  }
}

Annuler un Document​

Voir : mutation cancelDocument · documentCancelInput

mutation CancelDocument($input: documentCancelInput!) {
  cancelDocument(input: $input)
}

Copier un Modèle​

Voir : mutation copyTemplate · templateCopyInput

mutation CopyTemplate($input: templateCopyInput!) {
  copyTemplate(input: $input)
}

Opérations sur les Modèles​

Créer un Modèle​

Voir : mutation createTemplate · templateCreateInput

Crée un nouveau modèle. Voir Entrée Création de Modèle pour un exemple.

mutation CreateTemplate($input: templateCreateInput!) {
  createTemplate(input: $input) {
    id
    uploadUrl
  }
}

Variables d'Entrée :

{
  "input": {
    "groupId": "group-123",
    "title": "Employment Contract Template"
  }
}

Mettre à Jour un Modèle​

Voir : mutation updateTemplate · templateUpdateInput

mutation UpdateTemplate($input: templateUpdateInput!) {
  updateTemplate(input: $input)
}

Archiver un Modèle​

Voir : mutation archiveTemplate · templateArchiveInput

mutation ArchiveTemplate($input: templateArchiveInput!) {
  archiveTemplate(input: $input)
}

Créer un Élément de Modèle​

Voir : mutation createTemplateElement · templateElementCreateInput

Ajoute un nouvel élément (champ) à un modèle. Voir Entrée Création d’Élément de Modèle pour un exemple complet.

mutation CreateTemplateElement($input: templateElementCreateInput!) {
  createTemplateElement(input: $input)
}

Variables d'Entrée :

{
  "input": {
    "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"
  }
}

Mettre à Jour un Élément de Modèle​

Voir : mutation updateTemplateElement · templateElementUpdateInput

mutation UpdateTemplateElement($input: templateElementUpdateInput!) {
  updateTemplateElement(input: $input)
}

Supprimer un Élément de Modèle​

Voir : mutation deleteTemplateElement · templateElementDeleteInput

mutation DeleteTemplateElement($input: templateElementDeleteInput!) {
  deleteTemplateElement(input: $input)
}

Créer un Rôle de Modèle​

Voir : mutation createTemplateRole · templateRoleCreateInput

mutation CreateTemplateRole($input: templateRoleCreateInput!) {
  createTemplateRole(input: $input)
}

Mettre à Jour un Rôle de Modèle​

Voir : mutation updateTemplateRole · templateRoleUpdateInput

mutation UpdateTemplateRole($input: templateRoleUpdateInput!) {
  updateTemplateRole(input: $input)
}

Supprimer un Rôle de Modèle​

Voir : mutation deleteTemplateRole · templateRoleDeleteInput

mutation DeleteTemplateRole($input: templateRoleDeleteInput!) {
  deleteTemplateRole(input: $input)
}

Opérations sur les Contacts​

Créer un Contact​

Crée un nouveau contact. Voir Entrée Création de Contact pour un exemple.

mutation CreateContact($input: contactCreateInput!) {
  createContact(input: $input)
}

Variables d'Entrée :

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

Mettre à Jour un Contact​

Voir : mutation updateContact · contactUpdateInput

mutation UpdateContact($input: contactUpdateInput!) {
  updateContact(input: $input)
}

Supprimer un Contact​

Voir : mutation deleteContact · deleteContactInput

mutation DeleteContact($input: deleteContactInput!) {
  deleteContact(input: $input)
}

Créer un Groupe de Contacts​

Voir : mutation createContactGroup · contactGroupCreateInput

mutation CreateContactGroup($input: contactGroupCreateInput!) {
  createContactGroup(input: $input)
}

Mettre à Jour un Groupe de Contacts​

Voir : mutation updateContactGroup · contactGroupUpdateInput

mutation UpdateContactGroup($input: contactGroupUpdateInput!) {
  updateContactGroup(input: $input)
}

Supprimer un Groupe de Contacts​

Voir : mutation deleteContactGroup · contactGroupDeleteInput

mutation DeleteContactGroup($input: contactGroupDeleteInput!) {
  deleteContactGroup(input: $input)
}

Ajouter à un Groupe de Contacts​

Voir : mutation addToContactGroup · contactGroupAddInput

mutation AddToContactGroup($input: contactGroupAddInput!) {
  addToContactGroup(input: $input)
}

Retirer d'un Groupe de Contacts​

Voir : mutation removeFromContactGroup · contactGroupRemoveInput

mutation RemoveFromContactGroup($input: contactGroupRemoveInput!) {
  removeFromContactGroup(input: $input)
}

Opérations sur les Groupes​

Créer un Groupe​

Voir : mutation createGroup · groupCreateInput

Crée un nouveau groupe dans une organisation. Voir Entrée Création de Groupe pour un exemple.

mutation CreateGroup($input: groupCreateInput!) {
  createGroup(input: $input)
}

Variables d'Entrée :

{
  "input": {
    "organisationId": "org-123",
    "name": "Sales Department",
    "apiIntegration": false,
    "addExampleTemplate": true
  }
}

Mettre à Jour un Groupe​

Voir : mutation updateGroup · groupUpdateInput

mutation UpdateGroup($input: groupUpdateInput!) {
  updateGroup(input: $input)
}

Mettre à Jour un Membre de Groupe​

Voir : mutation updateGroupMember · groupMemberUpdateInput

mutation UpdateGroupMember($input: groupMemberUpdateInput!) {
  updateGroupMember(input: $input)
}

Supprimer un Membre de Groupe​

Voir : mutation deleteGroupMember · groupMemberDeleteInput

mutation DeleteGroupMember($input: groupMemberDeleteInput!) {
  deleteGroupMember(input: $input)
}

Opérations sur les Organisations​

Créer une Organisation​

Voir : mutation createOrganisation · organisationCreateInput

mutation CreateOrganisation($input: organisationCreateInput!) {
  createOrganisation(input: $input)
}

Mettre à Jour une Autorisation d'Organisation​

Voir : mutation updateOrganisationPermission · organisationPermissionUpdateInput

mutation UpdateOrganisationPermission($input: organisationPermissionUpdateInput!) {
  updateOrganisationPermission(input: $input)
}

Mettre à Jour la Rétention d'Organisation​

Voir : mutation updateOrganisationRetention · retentionRulesInput

mutation UpdateOrganisationRetention($input: retentionRulesInput!) {
  updateOrganisationRetention(input: $input)
}

Opérations sur les Expériences​

Créer une Expérience​

Crée une nouvelle expérience de signature. Voir Entrée Création d’Expérience pour un exemple complet.

mutation CreateExperience($input: experienceCreateInput!) {
  createExperience(input: $input)
}

Variables d'Entrée :

{
  "input": {
    "groupId": "group-123",
    "name": "Standard Signing Experience",
    "header": "Please sign this document",
    "text1": "Welcome to our signing process",
    "allowSignatureReuse": true,
    "defaultExperience": true,
    "language": "en"
  }
}

Mettre à Jour une Expérience​

mutation UpdateExperience($input: experienceUpdateInput!) {
  updateExperience(input: $input)
}

Supprimer une Expérience​

mutation DeleteExperience($input: experienceDeleteInput!) {
  deleteExperience(input: $input)
}

Copier une Expérience​

mutation CopyExperience($input: experienceCopyInput!) {
  copyExperience(input: $input)
}

Opérations de Lot​

Envoyer un Lot​

Voir : mutation sendBatch · SendBatchInput

mutation SendBatch($input: SendBatchInput!) {
  sendBatch(input: $input)
}

Envoyer un Document de Lot​

Voir : mutation sendBatchDocument · SendBatchDocumentInput

mutation SendBatchDocument($input: SendBatchDocumentInput!) {
  sendBatchDocument(input: $input)
}

Démarrer un Lot​

Voir : mutation startBatch · StartBatchInput

mutation StartBatch($input: StartBatchInput!) {
  startBatch(input: $input)
}

Envoyer en Masse​

Voir : mutation sendBulk · SendBulkInput

mutation SendBulk($input: SendBulkInput!) {
  sendBulk(input: $input)
}

Ajouter un Document en Masse​

Voir : mutation addBulkDocument · AddBulkDocumentInput

mutation AddBulkDocument($input: AddBulkDocumentInput!) {
  addBulkDocument(input: $input)
}

Démarrer un Envoi en Masse​

Voir : mutation startBulk · StartBulkInput

mutation StartBulk($input: StartBulkInput!) {
  startBulk(input: $input)
}

Opérations sur les Tâches​

Créer une Tâche​

Voir : mutation createTask · CreateTaskInput

mutation CreateTask($input: CreateTaskInput!) {
  createTask(input: $input) {
    id
    status
    listings
  }
}

Opérations sur les Destinataires​

Mettre à Jour un Destinataire​

Voir : mutation updateRecipient · RecipientUpdateInput

mutation UpdateRecipient($input: RecipientUpdateInput!) {
  updateRecipient(input: $input)
}

Réinitialiser un Destinataire​

Voir : mutation resetRecipient · ResetRecipientInput

mutation ResetRecipient($input: ResetRecipientInput!) {
  resetRecipient(input: $input)
}

Contacter un Destinataire​

Voir : mutation contactRecipient · contactRecipientInput

mutation ContactRecipient($input: contactRecipientInput!) {
  contactRecipient(input: $input)
}

Opérations sur les Utilisateurs​

Mettre à Jour un Utilisateur​

Voir : mutation updateUser · userUpdateInput

mutation UpdateUser($input: userUpdateInput!) {
  updateUser(input: $input)
}

Voir : mutation updateUserConsent · userUpdateConsentInput

mutation UpdateUserConsent($input: userUpdateConsentInput!) {
  updateUserConsent(input: $input)
}

Opérations sur les Pièces Jointes​

Créer une Pièce Jointe​

Voir : mutation createAttachment · attachmentCreateInput

mutation CreateAttachment($input: attachmentCreateInput!) {
  createAttachment(input: $input)
}

Supprimer une Pièce Jointe​

Voir : mutation deleteAttachment · attachmentDeleteInput

mutation DeleteAttachment($input: attachmentDeleteInput!) {
  deleteAttachment(input: $input)
}

Mettre à Jour la Pièce Jointe par Défaut​

Voir : mutation updateDefaultAttachment · attachmentUpdateDefaultInput

mutation UpdateDefaultAttachment($input: attachmentUpdateDefaultInput!) {
  updateDefaultAttachment(input: $input)
}

Opérations sur les Plannings​

Créer un Planning​

Voir : mutation createSchedule · scheduleCreateInput

mutation CreateSchedule($input: scheduleCreateInput!) {
  createSchedule(input: $input)
}

Mettre à Jour un Planning​

Voir : mutation updateSchedule · scheduleUpdateInput

mutation UpdateSchedule($input: scheduleUpdateInput!) {
  updateSchedule(input: $input)
}

Copier un Planning​

Voir : mutation copySchedule · scheduleCopyInput

mutation CopySchedule($input: scheduleCopyInput!) {
  copySchedule(input: $input)
}

Créer un Élément de Planning​

Voir : mutation createScheduleItem · scheduleItemCreateInput

mutation CreateScheduleItem($input: scheduleItemCreateInput!) {
  createScheduleItem(input: $input)
}

Mettre à Jour un Élément de Planning​

Voir : mutation updateScheduleItem · scheduleItemUpdateInput

mutation UpdateScheduleItem($input: scheduleItemUpdateInput!) {
  updateScheduleItem(input: $input)
}

Supprimer un Élément de Planning​

Voir : mutation deleteScheduleItem · scheduleItemDeleteInput

mutation DeleteScheduleItem($input: scheduleItemDeleteInput!) {
  deleteScheduleItem(input: $input)
}

Opérations sur les Messages Standards​

Créer un Message Standard​

Voir : mutation createStandardMessage · standardMessageCreateInput

mutation CreateStandardMessage($input: standardMessageCreateInput!) {
  createStandardMessage(input: $input)
}

Supprimer un Message Standard​

Voir : mutation deleteStandardMessage · standardMessageDeleteInput

mutation DeleteStandardMessage($input: standardMessageDeleteInput!) {
  deleteStandardMessage(input: $input)
}

Mettre à Jour le Message Standard par Défaut​

Voir : mutation updateDefaultStandardMessage · standardMessageUpdateDefaultInput

mutation UpdateDefaultStandardMessage($input: standardMessageUpdateDefaultInput!) {
  updateDefaultStandardMessage(input: $input)
}

Opérations sur les Invitations​

Créer une Invitation​

Voir : mutation createInvitation · invitationCreateInput

mutation CreateInvitation($input: invitationCreateInput!) {
  createInvitation(input: $input)
}

Supprimer une Invitation​

Voir : mutation deleteInvitation · invitationDeleteInput

mutation DeleteInvitation($input: invitationDeleteInput!) {
  deleteInvitation(input: $input)
}

Opérations Cloud Store​

Créer un Cloud Store​

Voir : mutation createCloudStore · cloudStoreCreateInput

mutation CreateCloudStore($input: cloudStoreCreateInput!) {
  createCloudStore(input: $input)
}

Mettre à Jour un Cloud Store​

Voir : mutation updateCloudStore · cloudStoreUpdateInput

mutation UpdateCloudStore($input: cloudStoreUpdateInput!) {
  updateCloudStore(input: $input)
}

Supprimer un Cloud Store​

Voir : mutation deleteCloudStore · cloudStoreDeleteInput

mutation DeleteCloudStore($input: cloudStoreDeleteInput!) {
  deleteCloudStore(input: $input)
}

Tester un Cloud Store​

Voir : mutation testCloudStore · cloudStoreTestInput

mutation TestCloudStore($input: cloudStoreTestInput!) {
  testCloudStore(input: $input)
}

Opérations sur les Brouillons​

Créer un Brouillon​

Voir : mutation createDraft · draftCreateInput

mutation CreateDraft($input: draftCreateInput!) {
  createDraft(input: $input)
}

Mettre à Jour un Brouillon​

Voir : mutation updateDraft · draftUpdateInput

mutation UpdateDraft($input: draftUpdateInput!) {
  updateDraft(input: $input)
}

Supprimer un Brouillon​

Voir : mutation deleteDraft · draftDeleteInput

mutation DeleteDraft($input: draftDeleteInput!) {
  deleteDraft(input: $input)
}

Voir : mutation createDirectLink · directLinkInput

mutation CreateDirectLink($input: directLinkInput!) {
  createDirectLink(input: $input)
}

Voir : mutation deleteDirectLink · directLinkDeleteInput

mutation DeleteDirectLink($input: directLinkDeleteInput!) {
  deleteDirectLink(input: $input)
}

Opérations sur les Données​

Créer une Interruption de Données​

Voir : mutation createDataStop · DataStopInput

mutation CreateDataStop($input: DataStopInput!) {
  createDataStop(input: $input) {
    id
    email
    created
    userId
  }
}

Supprimer une Interruption de Données​

Voir : mutation deleteDataStop · DataStopInput

mutation DeleteDataStop($input: DataStopInput!) {
  deleteDataStop(input: $input) {
    id
    email
    created
    userId
  }
}

Opérations sur les Webhooks​

Créer un Webhook​

Voir : mutation createWebhook · WebhookCreateInput

Crée un webhook pour les notifications d'événements. Voir Entrée Création de Webhook pour un exemple.

mutation CreateWebhook($input: WebhookCreateInput!) {
  createWebhook(input: $input)
}

Variables d'Entrée :

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

Mettre à Jour un Webhook​

Voir : mutation updateWebhook · WebhookUpdateInput

mutation UpdateWebhook($input: WebhookUpdateInput!) {
  updateWebhook(input: $input)
}

Supprimer un Webhook​

Voir : mutation deleteWebhook · webhookDeleteInput

mutation DeleteWebhook($input: webhookDeleteInput!) {
  deleteWebhook(input: $input)
}

Opérations de Support​

Créer un Ticket de Support​

Voir : mutation createSupportTicket · supportTicketCreateInput

Crée un ticket de support. Voir Entrée Création de Ticket de Support pour un exemple.

mutation CreateSupportTicket($input: supportTicketCreateInput!) {
  createSupportTicket(input: $input)
}

Variables d'Entrée :

{
  "input": {
    "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."
  }
}

Créer un Retour d'Information​

Voir : mutation createFeedback · feedbackCreateInput

Soumet un retour d'information. Voir Entrée Création de Retour d'Information pour un exemple.

mutation CreateFeedback($input: feedbackCreateInput!) {
  createFeedback(input: $input)
}

Variables d'Entrée :

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

Créer une Demande de Vente​

Voir : mutation createSalesRequest · salesRequestCreateInput

Crée une demande de renseignement commercial.

mutation CreateSalesRequest($input: salesRequestCreateInput!) {
  createSalesRequest(input: $input)
}

Variables d'Entrée :

{
  "input": {
    "description": "Interested in enterprise features for our 500+ user organization",
    "email": "sales-inquiry@example.com"
  }
}

Opérations Utilitaires​

Marquer comme Terminé​

Voir : mutation markAsComplete · markAsCompleteInput

mutation MarkAsComplete($input: markAsCompleteInput!) {
  markAsComplete(input: $input)
}

PDF vers Image​

Voir : mutation pdfToImage · pdfToImageInput

mutation PdfToImage($input: pdfToImageInput!) {
  pdfToImage(input: $input)
}

Tester Email SMTP​

Voir : mutation testSMTPEmail · smtpTestInput

mutation TestSMTPEmail($input: smtpTestInput!) {
  testSMTPEmail(input: $input)
}

Sauvegarder une Session​

Voir : mutation saveSession · sessionInput

mutation SaveSession($input: sessionInput!) {
  saveSession(input: $input)
}

Échanger les Rôles​

Voir : mutation swapRoles · swapRolesInput

mutation SwapRoles($input: swapRolesInput!) {
  swapRoles(input: $input)
}

Fusionner les Modèles​

Voir : mutation mergeTemplates · templateMergeInput

mutation MergeTemplates($input: templateMergeInput!) {
  mergeTemplates(input: $input)
}

Copier les Champs du Modèle​

Voir : mutation copyTemplateFields · templateFieldsCopyInput

mutation CopyTemplateFields($input: templateFieldsCopyInput!) {
  copyTemplateFields(input: $input)
}

Mettre à Jour les Éléments Expirants​

Voir : mutation updateExpiringItems · expiringItemUpdateInput

mutation UpdateExpiringItems($input: expiringItemUpdateInput!) {
  updateExpiringItems(input: $input) {
    id
    status
    listings
  }
}

Mettre à Jour la Facturation​

Voir : mutation updateBilling · billingUpdateInput

mutation UpdateBilling($input: billingUpdateInput!) {
  updateBilling(input: $input)
}

Annuler la Facturation​

Voir : mutation cancelBilling · billingCancelInput

mutation CancelBilling($input: billingCancelInput!) {
  cancelBilling(input: $input)
}

Mettre à Jour un Champ de Signataire​

Voir : mutation updateSignerField · signerUpdateInput

mutation UpdateSignerField($input: signerUpdateInput!) {
  updateSignerField(input: $input)
}

Opérations sur la Signature Utilisateur​

Créer un Élément de Signature Utilisateur​

Voir : mutation createUserSignatureElement · userSignatureElementCreateInput

mutation CreateUserSignatureElement($input: userSignatureElementCreateInput!) {
  createUserSignatureElement(input: $input)
}

Mettre à Jour un Élément de Signature Utilisateur​

Voir : mutation updateUserSignatureElement · userSignatureElementUpdateInput

mutation UpdateUserSignatureElement($input: userSignatureElementUpdateInput!) {
  updateUserSignatureElement(input: $input)
}

Supprimer un Élément de Signature Utilisateur​

Voir : mutation deleteUserSignatureElement · userSignatureElementDeleteInput

mutation DeleteUserSignatureElement($input: userSignatureElementDeleteInput!) {
  deleteUserSignatureElement(input: $input)
}

Opérations sur les Tags de Modèle​

Créer un Tag de Modèle​

Voir : mutation createTemplateTag · templateTagCreateInput

mutation CreateTemplateTag($input: templateTagCreateInput!) {
  createTemplateTag(input: $input)
}

Supprimer un Tag de Modèle​

Voir : mutation deleteTemplateTag · templateTagDeleteInput

mutation DeleteTemplateTag($input: templateTagDeleteInput!) {
  deleteTemplateTag(input: $input)
}

Opérations de Publication​

Publier à un Utilisateur​

Voir : mutation publishToUser

mutation PublishToUser($userId: ID!, $data: AWSJSON!) {
  publishToUser(userId: $userId, data: $data) {
    userId
    data
  }
}

Publier à un Groupe​

Voir : mutation publishToGroup

mutation PublishToGroup($groupId: ID!, $data: AWSJSON!) {
  publishToGroup(groupId: $groupId, data: $data) {
    groupId
    data
  }
}

Export This Article

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