Zum Hauptinhalt springen

Mutationsbeispiele

Diese Beispiele zeigen die GraphQL-Syntax für jede Mutation. Für vollständige Details zu Eingabefeldern siehe die einzelnen Mutationsreferenzseiten und Eingabereferenzseiten.

Tipp

Für detaillierte Strukturen und Beispiele von Eingabeobjekten siehe Eingabe-Beispiele.

Dokumentoperationen​

Dokument senden​

Siehe: send Mutation · DocumentSendSettingsInput

Sendet ein Dokument zur Unterzeichnung. Siehe Document Send Settings Input für ein vollständiges Beispiel.

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

Eingabevariablen:

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

Dokument stornieren​

Siehe: cancelDocument Mutation · documentCancelInput

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

Vorlage kopieren​

Siehe: copyTemplate Mutation · templateCopyInput

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

Vorlagenoperationen​

Vorlage erstellen​

Siehe: createTemplate Mutation · templateCreateInput

Erstellt eine neue Vorlage. Siehe Template Create Input für ein Beispiel.

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

Eingabevariablen:

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

Vorlage aktualisieren​

Siehe: updateTemplate Mutation · templateUpdateInput

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

Vorlage archivieren​

Siehe: archiveTemplate Mutation · templateArchiveInput

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

Vorlagenelement erstellen​

Siehe: createTemplateElement Mutation · templateElementCreateInput

Fügt einer Vorlage ein neues Element (Feld) hinzu. Siehe Template Element Create Input für ein vollständiges Beispiel.

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

Eingabevariablen:

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

Vorlagenelement aktualisieren​

Siehe: updateTemplateElement Mutation · templateElementUpdateInput

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

Vorlagenelement löschen​

Siehe: deleteTemplateElement Mutation · templateElementDeleteInput

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

Vorlagenrolle erstellen​

Siehe: createTemplateRole Mutation · templateRoleCreateInput

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

Vorlagenrolle aktualisieren​

Siehe: updateTemplateRole Mutation · templateRoleUpdateInput

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

Vorlagenrolle löschen​

Siehe: deleteTemplateRole Mutation · templateRoleDeleteInput

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

Kontaktoperationen​

Kontakt erstellen​

Erstellt einen neuen Kontakt. Siehe Contact Create Input für ein Beispiel.

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

Eingabevariablen:

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

Kontakt aktualisieren​

Siehe: updateContact Mutation · contactUpdateInput

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

Kontakt löschen​

Siehe: deleteContact Mutation · deleteContactInput

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

Kontaktgruppe erstellen​

Siehe: createContactGroup Mutation · contactGroupCreateInput

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

Kontaktgruppe aktualisieren​

Siehe: updateContactGroup Mutation · contactGroupUpdateInput

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

Kontaktgruppe löschen​

Siehe: deleteContactGroup Mutation · contactGroupDeleteInput

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

Zur Kontaktgruppe hinzufügen​

Siehe: addToContactGroup Mutation · contactGroupAddInput

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

Aus Kontaktgruppe entfernen​

Siehe: removeFromContactGroup Mutation · contactGroupRemoveInput

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

Gruppenoperationen​

Gruppe erstellen​

Siehe: createGroup Mutation · groupCreateInput

Erstellt eine neue Gruppe in einer Organisation. Siehe Group Create Input für ein Beispiel.

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

Eingabevariablen:

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

Gruppe aktualisieren​

Siehe: updateGroup Mutation · groupUpdateInput

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

Gruppenmitglied aktualisieren​

Siehe: updateGroupMember Mutation · groupMemberUpdateInput

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

Gruppenmitglied löschen​

Siehe: deleteGroupMember Mutation · groupMemberDeleteInput

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

Organisationsoperationen​

Organisation erstellen​

Siehe: createOrganisation Mutation · organisationCreateInput

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

Organisationsberechtigung aktualisieren​

Siehe: updateOrganisationPermission Mutation · organisationPermissionUpdateInput

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

Organisationsaufbewahrung aktualisieren​

Siehe: updateOrganisationRetention Mutation · retentionRulesInput

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

Erlebnisoperationen​

Erlebnis erstellen​

Erstellt ein neues Unterschriftenerlebnis. Siehe Experience Create Input für ein vollständiges Beispiel.

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

Eingabevariablen:

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

Erlebnis aktualisieren​

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

Erlebnis löschen​

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

Erlebnis kopieren​

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

Stapeloperationen​

Stapel senden​

Siehe: sendBatch Mutation · SendBatchInput

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

Stapeldokument senden​

Siehe: sendBatchDocument Mutation · SendBatchDocumentInput

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

Stapel starten​

Siehe: startBatch Mutation · StartBatchInput

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

Massenversand senden​

Siehe: sendBulk Mutation · SendBulkInput

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

Massen-Dokument hinzufügen​

Siehe: addBulkDocument Mutation · AddBulkDocumentInput

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

Massenversand starten​

Siehe: startBulk Mutation · StartBulkInput

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

Aufgabenoperationen​

Aufgabe erstellen​

Siehe: createTask Mutation · CreateTaskInput

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

Empfängeroperationen​

Empfänger aktualisieren​

Siehe: updateRecipient Mutation · RecipientUpdateInput

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

Empfänger zurücksetzen​

Siehe: resetRecipient Mutation · ResetRecipientInput

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

Empfänger kontaktieren​

Siehe: contactRecipient Mutation · contactRecipientInput

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

Benutzeroperationen​

Benutzer aktualisieren​

Siehe: updateUser Mutation · userUpdateInput

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

Siehe: updateUserConsent Mutation · userUpdateConsentInput

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

Anhangoperationen​

Anhang erstellen​

Siehe: createAttachment Mutation · attachmentCreateInput

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

Anhang löschen​

Siehe: deleteAttachment Mutation · attachmentDeleteInput

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

Standardanhang aktualisieren​

Siehe: updateDefaultAttachment Mutation · attachmentUpdateDefaultInput

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

Terminplanung Operationen​

Terminplan erstellen​

Siehe: createSchedule Mutation · scheduleCreateInput

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

Terminplan aktualisieren​

Siehe: updateSchedule Mutation · scheduleUpdateInput

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

Terminplan kopieren​

Siehe: copySchedule Mutation · scheduleCopyInput

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

Terminplanelement erstellen​

Siehe: createScheduleItem Mutation · scheduleItemCreateInput

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

Terminplanelement aktualisieren​

Siehe: updateScheduleItem Mutation · scheduleItemUpdateInput

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

Terminplanelement löschen​

Siehe: deleteScheduleItem Mutation · scheduleItemDeleteInput

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

Standardnachrichten Operationen​

Standardnachricht erstellen​

Siehe: createStandardMessage Mutation · standardMessageCreateInput

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

Standardnachricht löschen​

Siehe: deleteStandardMessage Mutation · standardMessageDeleteInput

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

Standardnachricht Standard aktualisieren​

Siehe: updateDefaultStandardMessage Mutation · standardMessageUpdateDefaultInput

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

Einladungsoperationen​

Einladung erstellen​

Siehe: createInvitation Mutation · invitationCreateInput

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

Einladung löschen​

Siehe: deleteInvitation Mutation · invitationDeleteInput

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

Cloud-Store-Operationen​

Cloud Store erstellen​

Siehe: createCloudStore Mutation · cloudStoreCreateInput

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

Cloud Store aktualisieren​

Siehe: updateCloudStore Mutation · cloudStoreUpdateInput

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

Cloud Store löschen​

Siehe: deleteCloudStore Mutation · cloudStoreDeleteInput

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

Cloud Store testen​

Siehe: testCloudStore Mutation · cloudStoreTestInput

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

Entwurfsoperationen​

Entwurf erstellen​

Siehe: createDraft Mutation · draftCreateInput

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

Entwurf aktualisieren​

Siehe: updateDraft Mutation · draftUpdateInput

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

Entwurf löschen​

Siehe: deleteDraft Mutation · draftDeleteInput

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

Siehe: createDirectLink Mutation · directLinkInput

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

Siehe: deleteDirectLink Mutation · directLinkDeleteInput

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

Datenoperationen​

Datenstopp erstellen​

Siehe: createDataStop Mutation · DataStopInput

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

Datenstopp löschen​

Siehe: deleteDataStop Mutation · DataStopInput

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

Webhook-Operationen​

Webhook erstellen​

Siehe: createWebhook Mutation · WebhookCreateInput

Erstellt einen Webhook für Ereignisbenachrichtigungen. Siehe Webhook Create Input für ein Beispiel.

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

Eingabevariablen:

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

Webhook aktualisieren​

Siehe: updateWebhook Mutation · WebhookUpdateInput

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

Webhook löschen​

Siehe: deleteWebhook Mutation · webhookDeleteInput

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

Support-Operationen​

Support-Ticket erstellen​

Siehe: createSupportTicket Mutation · supportTicketCreateInput

Erstellt ein Support-Ticket. Siehe Support Ticket Create Input für ein Beispiel.

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

Eingabevariablen:

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

Feedback erstellen​

Siehe: createFeedback Mutation · feedbackCreateInput

Sendet Feedback. Siehe Feedback Create Input für ein Beispiel.

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

Eingabevariablen:

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

Verkaufsanfrage erstellen​

Siehe: createSalesRequest Mutation · salesRequestCreateInput

Erstellt eine Verkaufsanfrage.

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

Eingabevariablen:

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

Dienstprogramm-Operationen​

Als abgeschlossen markieren​

Siehe: markAsComplete Mutation · markAsCompleteInput

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

PDF zu Bild​

Siehe: pdfToImage Mutation · pdfToImageInput

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

SMTP-Test-E-Mail​

Siehe: testSMTPEmail Mutation · smtpTestInput

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

Sitzung speichern​

Siehe: saveSession Mutation · sessionInput

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

Rollen tauschen​

Siehe: swapRoles Mutation · swapRolesInput

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

Vorlagen zusammenführen​

Siehe: mergeTemplates Mutation · templateMergeInput

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

Vorlagenfelder kopieren​

Siehe: copyTemplateFields Mutation · templateFieldsCopyInput

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

Ablaufende Elemente aktualisieren​

Siehe: updateExpiringItems Mutation · expiringItemUpdateInput

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

Abrechnung aktualisieren​

Siehe: updateBilling Mutation · billingUpdateInput

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

Abrechnung stornieren​

Siehe: cancelBilling Mutation · billingCancelInput

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

Unterzeichnerfeld aktualisieren​

Siehe: updateSignerField Mutation · signerUpdateInput

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

Benutzerunterschriftsoperationen​

Benutzersignaturelement erstellen​

Siehe: createUserSignatureElement Mutation · userSignatureElementCreateInput

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

Benutzersignaturelement aktualisieren​

Siehe: updateUserSignatureElement Mutation · userSignatureElementUpdateInput

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

Benutzersignaturelement löschen​

Siehe: deleteUserSignatureElement Mutation · userSignatureElementDeleteInput

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

Vorlagen-Tag-Operationen​

Vorlagen-Tag erstellen​

Siehe: createTemplateTag Mutation · templateTagCreateInput

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

Vorlagen-Tag löschen​

Siehe: deleteTemplateTag Mutation · templateTagDeleteInput

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

Veröffentlichungsoperationen​

An Benutzer veröffentlichen​

Siehe: publishToUser Mutation

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

An Gruppe veröffentlichen​

Siehe: 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.