Vai al contenuto principale

Esempi di Mutation

Questi esempi mostrano la sintassi GraphQL per ogni mutation. Per i dettagli completi dei campi di input, consulta le rispettive pagine di riferimento delle mutation e le pagine di riferimento degli input.

suggerimento

Per strutture dettagliate degli oggetti di input ed esempi, vedi Esempi di Input.

Operazioni su Documenti​

Invia Documento​

Vedi: send mutation · DocumentSendSettingsInput

Invia un documento per la firma. Consulta Impostazioni di Invio Documento Input per un esempio completo.

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

Variabili di Input:

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

Annulla Documento​

Vedi: cancelDocument mutation · documentCancelInput

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

Copia Modello​

Vedi: copyTemplate mutation · templateCopyInput

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

Operazioni su Modelli​

Crea Modello​

Vedi: createTemplate mutation · templateCreateInput

Crea un nuovo modello. Consulta Crea Modello Input per un esempio.

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

Variabili di Input:

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

Aggiorna Modello​

Vedi: updateTemplate mutation · templateUpdateInput

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

Archivia Modello​

Vedi: archiveTemplate mutation · templateArchiveInput

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

Crea Elemento Modello​

Vedi: createTemplateElement mutation · templateElementCreateInput

Aggiunge un nuovo elemento (campo) a un modello. Consulta Crea Elemento Modello Input per un esempio completo.

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

Variabili di Input:

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

Aggiorna Elemento Modello​

Vedi: updateTemplateElement mutation · templateElementUpdateInput

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

Elimina Elemento Modello​

Vedi: deleteTemplateElement mutation · templateElementDeleteInput

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

Crea Ruolo Modello​

Vedi: createTemplateRole mutation · templateRoleCreateInput

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

Aggiorna Ruolo Modello​

Vedi: updateTemplateRole mutation · templateRoleUpdateInput

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

Elimina Ruolo Modello​

Vedi: deleteTemplateRole mutation · templateRoleDeleteInput

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

Operazioni Contatto​

Crea Contatto​

Crea un nuovo contatto. Consulta Crea Contatto Input per un esempio.

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

Variabili di Input:

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

Aggiorna Contatto​

Vedi: updateContact mutation · contactUpdateInput

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

Elimina Contatto​

Vedi: deleteContact mutation · deleteContactInput

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

Crea Gruppo Contatti​

Vedi: createContactGroup mutation · contactGroupCreateInput

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

Aggiorna Gruppo Contatti​

Vedi: updateContactGroup mutation · contactGroupUpdateInput

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

Elimina Gruppo Contatti​

Vedi: deleteContactGroup mutation · contactGroupDeleteInput

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

Aggiungi al Gruppo Contatti​

Vedi: addToContactGroup mutation · contactGroupAddInput

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

Rimuovi dal Gruppo Contatti​

Vedi: removeFromContactGroup mutation · contactGroupRemoveInput

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

Operazioni Gruppo​

Crea Gruppo​

Vedi: createGroup mutation · groupCreateInput

Crea un nuovo gruppo in un’organizzazione. Consulta Crea Gruppo Input per un esempio.

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

Variabili di Input:

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

Aggiorna Gruppo​

Vedi: updateGroup mutation · groupUpdateInput

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

Aggiorna Membro Gruppo​

Vedi: updateGroupMember mutation · groupMemberUpdateInput

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

Elimina Membro Gruppo​

Vedi: deleteGroupMember mutation · groupMemberDeleteInput

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

Operazioni Organizzazione​

Crea Organizzazione​

Vedi: createOrganisation mutation · organisationCreateInput

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

Aggiorna Permesso Organizzazione​

Vedi: updateOrganisationPermission mutation · organisationPermissionUpdateInput

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

Aggiorna Conservazione Organizzazione​

Vedi: updateOrganisationRetention mutation · retentionRulesInput

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

Operazioni Experience​

Crea Experience​

Crea una nuova esperienza di firma. Consulta Crea Experience Input per un esempio completo.

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

Variabili di Input:

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

Aggiorna Experience​

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

Elimina Experience​

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

Copia Experience​

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

Operazioni Batch​

Invia Batch​

Vedi: sendBatch mutation · SendBatchInput

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

Invia Documento Batch​

Vedi: sendBatchDocument mutation · SendBatchDocumentInput

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

Avvia Batch​

Vedi: startBatch mutation · StartBatchInput

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

Invia Bulk​

Vedi: sendBulk mutation · SendBulkInput

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

Aggiungi Documento Bulk​

Vedi: addBulkDocument mutation · AddBulkDocumentInput

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

Avvia Bulk​

Vedi: startBulk mutation · StartBulkInput

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

Operazioni Compito​

Crea Compito​

Vedi: createTask mutation · CreateTaskInput

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

Operazioni Destinatario​

Aggiorna Destinatario​

Vedi: updateRecipient mutation · RecipientUpdateInput

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

Reimposta Destinatario​

Vedi: resetRecipient mutation · ResetRecipientInput

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

Contatta Destinatario​

Vedi: contactRecipient mutation · contactRecipientInput

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

Operazioni Utente​

Aggiorna Utente​

Vedi: updateUser mutation · userUpdateInput

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

Vedi: updateUserConsent mutation · userUpdateConsentInput

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

Operazioni Allegato​

Crea Allegato​

Vedi: createAttachment mutation · attachmentCreateInput

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

Elimina Allegato​

Vedi: deleteAttachment mutation · attachmentDeleteInput

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

Aggiorna Allegato Predefinito​

Vedi: updateDefaultAttachment mutation · attachmentUpdateDefaultInput

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

Operazioni Programmazione​

Crea Programmazione​

Vedi: createSchedule mutation · scheduleCreateInput

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

Aggiorna Programmazione​

Vedi: updateSchedule mutation · scheduleUpdateInput

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

Copia Programmazione​

Vedi: copySchedule mutation · scheduleCopyInput

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

Crea Elemento Programmazione​

Vedi: createScheduleItem mutation · scheduleItemCreateInput

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

Aggiorna Elemento Programmazione​

Vedi: updateScheduleItem mutation · scheduleItemUpdateInput

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

Elimina Elemento Programmazione​

Vedi: deleteScheduleItem mutation · scheduleItemDeleteInput

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

Operazioni Messaggio Standard​

Crea Messaggio Standard​

Vedi: createStandardMessage mutation · standardMessageCreateInput

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

Elimina Messaggio Standard​

Vedi: deleteStandardMessage mutation · standardMessageDeleteInput

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

Aggiorna Messaggio Standard Predefinito​

Vedi: updateDefaultStandardMessage mutation · standardMessageUpdateDefaultInput

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

Operazioni Invito​

Crea Invito​

Vedi: createInvitation mutation · invitationCreateInput

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

Elimina Invito​

Vedi: deleteInvitation mutation · invitationDeleteInput

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

Operazioni Cloud Store​

Crea Cloud Store​

Vedi: createCloudStore mutation · cloudStoreCreateInput

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

Aggiorna Cloud Store​

Vedi: updateCloudStore mutation · cloudStoreUpdateInput

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

Elimina Cloud Store​

Vedi: deleteCloudStore mutation · cloudStoreDeleteInput

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

Test Cloud Store​

Vedi: testCloudStore mutation · cloudStoreTestInput

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

Operazioni Bozza​

Crea Bozza​

Vedi: createDraft mutation · draftCreateInput

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

Aggiorna Bozza​

Vedi: updateDraft mutation · draftUpdateInput

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

Elimina Bozza​

Vedi: deleteDraft mutation · draftDeleteInput

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

Vedi: createDirectLink mutation · directLinkInput

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

Vedi: deleteDirectLink mutation · directLinkDeleteInput

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

Operazioni Dati​

Crea Arresto Dati​

Vedi: createDataStop mutation · DataStopInput

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

Elimina Arresto Dati​

Vedi: deleteDataStop mutation · DataStopInput

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

Operazioni Webhook​

Crea Webhook​

Vedi: createWebhook mutation · WebhookCreateInput

Crea un webhook per le notifiche di eventi. Consulta Crea Webhook Input per un esempio.

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

Variabili di Input:

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

Aggiorna Webhook​

Vedi: updateWebhook mutation · WebhookUpdateInput

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

Elimina Webhook​

Vedi: deleteWebhook mutation · webhookDeleteInput

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

Operazioni Supporto​

Crea Ticket Supporto​

Vedi: createSupportTicket mutation · supportTicketCreateInput

Crea un ticket di supporto. Consulta Crea Ticket Supporto Input per un esempio.

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

Variabili di Input:

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

Crea Feedback​

Vedi: createFeedback mutation · feedbackCreateInput

Invia un feedback. Consulta Crea Feedback Input per un esempio.

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

Variabili di Input:

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

Crea Richiesta Vendite​

Vedi: createSalesRequest mutation · salesRequestCreateInput

Crea una richiesta di informazioni di vendita.

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

Variabili di Input:

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

Operazioni Utility​

Segna come Completato​

Vedi: markAsComplete mutation · markAsCompleteInput

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

PDF a Immagine​

Vedi: pdfToImage mutation · pdfToImageInput

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

Test Email SMTP​

Vedi: testSMTPEmail mutation · smtpTestInput

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

Salva Sessione​

Vedi: saveSession mutation · sessionInput

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

Scambia Ruoli​

Vedi: swapRoles mutation · swapRolesInput

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

Unisci Modelli​

Vedi: mergeTemplates mutation · templateMergeInput

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

Copia Campi Modello​

Vedi: copyTemplateFields mutation · templateFieldsCopyInput

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

Aggiorna Elementi in Scadenza​

Vedi: updateExpiringItems mutation · expiringItemUpdateInput

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

Aggiorna Fatturazione​

Vedi: updateBilling mutation · billingUpdateInput

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

Annulla Fatturazione​

Vedi: cancelBilling mutation · billingCancelInput

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

Aggiorna Campo Firmatario​

Vedi: updateSignerField mutation · signerUpdateInput

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

Operazioni Firma Utente​

Crea Elemento Firma Utente​

Vedi: createUserSignatureElement mutation · userSignatureElementCreateInput

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

Aggiorna Elemento Firma Utente​

Vedi: updateUserSignatureElement mutation · userSignatureElementUpdateInput

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

Elimina Elemento Firma Utente​

Vedi: deleteUserSignatureElement mutation · userSignatureElementDeleteInput

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

Operazioni Tag Modello​

Crea Tag Modello​

Vedi: createTemplateTag mutation · templateTagCreateInput

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

Elimina Tag Modello​

Vedi: deleteTemplateTag mutation · templateTagDeleteInput

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

Operazioni Pubblicazione​

Pubblica a Utente​

Vedi: publishToUser mutation

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

Pubblica a Gruppo​

Vedi: publishToGroup mutation

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.