Skip to main content

Mutation Examples

These examples show the GraphQL syntax for each mutation. For full input field details, see the individual mutation reference pages and input reference pages.

tip

For detailed input object structures and examples, see Input Examples.

Document Operations​

Send Document​

See: send mutation · DocumentSendSettingsInput

Sends a document for signing. See Document Send Settings Input for full example.

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

Input Variables:

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

Cancel Document​

See: cancelDocument mutation · documentCancelInput

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

Copy Template​

See: copyTemplate mutation · templateCopyInput

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

Template Operations​

Create Template​

See: createTemplate mutation · templateCreateInput

Creates a new template. See Template Create Input for example.

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

Input Variables:

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

Update Template​

See: updateTemplate mutation · templateUpdateInput

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

Archive Template​

See: archiveTemplate mutation · templateArchiveInput

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

Create Template Element​

See: createTemplateElement mutation · templateElementCreateInput

Adds a new element (field) to a template. See Template Element Create Input for full example.

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

Input Variables:

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

Update Template Element​

See: updateTemplateElement mutation · templateElementUpdateInput

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

Delete Template Element​

See: deleteTemplateElement mutation · templateElementDeleteInput

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

Create Template Role​

See: createTemplateRole mutation · templateRoleCreateInput

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

Update Template Role​

See: updateTemplateRole mutation · templateRoleUpdateInput

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

Delete Template Role​

See: deleteTemplateRole mutation · templateRoleDeleteInput

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

Contact Operations​

Create Contact​

Creates a new contact. See Contact Create Input for example.

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

Input Variables:

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

Update Contact​

See: updateContact mutation · contactUpdateInput

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

Delete Contact​

See: deleteContact mutation · deleteContactInput

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

Create Contact Group​

See: createContactGroup mutation · contactGroupCreateInput

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

Update Contact Group​

See: updateContactGroup mutation · contactGroupUpdateInput

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

Delete Contact Group​

See: deleteContactGroup mutation · contactGroupDeleteInput

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

Add To Contact Group​

See: addToContactGroup mutation · contactGroupAddInput

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

Remove From Contact Group​

See: removeFromContactGroup mutation · contactGroupRemoveInput

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

Group Operations​

Create Group​

See: createGroup mutation · groupCreateInput

Creates a new group in an organisation. See Group Create Input for example.

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

Input Variables:

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

Update Group​

See: updateGroup mutation · groupUpdateInput

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

Update Group Member​

See: updateGroupMember mutation · groupMemberUpdateInput

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

Delete Group Member​

See: deleteGroupMember mutation · groupMemberDeleteInput

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

Organisation Operations​

Create Organisation​

See: createOrganisation mutation · organisationCreateInput

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

Update Organisation Permission​

See: updateOrganisationPermission mutation · organisationPermissionUpdateInput

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

Update Organisation Retention​

See: updateOrganisationRetention mutation · retentionRulesInput

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

Experience Operations​

Create Experience​

Creates a new signing experience. See Experience Create Input for full example.

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

Input Variables:

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

Update Experience​

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

Delete Experience​

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

Copy Experience​

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

Batch Operations​

Send Batch​

See: sendBatch mutation · SendBatchInput

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

Send Batch Document​

See: sendBatchDocument mutation · SendBatchDocumentInput

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

Start Batch​

See: startBatch mutation · StartBatchInput

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

Send Bulk​

See: sendBulk mutation · SendBulkInput

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

Add Bulk Document​

See: addBulkDocument mutation · AddBulkDocumentInput

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

Start Bulk​

See: startBulk mutation · StartBulkInput

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

Task Operations​

Create Task​

See: createTask mutation · CreateTaskInput

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

Recipient Operations​

Update Recipient​

See: updateRecipient mutation · RecipientUpdateInput

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

Reset Recipient​

See: resetRecipient mutation · ResetRecipientInput

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

Contact Recipient​

See: contactRecipient mutation · contactRecipientInput

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

User Operations​

Update User​

See: updateUser mutation · userUpdateInput

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

See: updateUserConsent mutation · userUpdateConsentInput

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

Attachment Operations​

Create Attachment​

See: createAttachment mutation · attachmentCreateInput

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

Delete Attachment​

See: deleteAttachment mutation · attachmentDeleteInput

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

Update Default Attachment​

See: updateDefaultAttachment mutation · attachmentUpdateDefaultInput

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

Schedule Operations​

Create Schedule​

See: createSchedule mutation · scheduleCreateInput

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

Update Schedule​

See: updateSchedule mutation · scheduleUpdateInput

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

Copy Schedule​

See: copySchedule mutation · scheduleCopyInput

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

Create Schedule Item​

See: createScheduleItem mutation · scheduleItemCreateInput

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

Update Schedule Item​

See: updateScheduleItem mutation · scheduleItemUpdateInput

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

Delete Schedule Item​

See: deleteScheduleItem mutation · scheduleItemDeleteInput

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

Standard Message Operations​

Create Standard Message​

See: createStandardMessage mutation · standardMessageCreateInput

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

Delete Standard Message​

See: deleteStandardMessage mutation · standardMessageDeleteInput

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

Update Default Standard Message​

See: updateDefaultStandardMessage mutation · standardMessageUpdateDefaultInput

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

Invitation Operations​

Create Invitation​

See: createInvitation mutation · invitationCreateInput

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

Delete Invitation​

See: deleteInvitation mutation · invitationDeleteInput

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

Cloud Store Operations​

Create Cloud Store​

See: createCloudStore mutation · cloudStoreCreateInput

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

Update Cloud Store​

See: updateCloudStore mutation · cloudStoreUpdateInput

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

Delete Cloud Store​

See: deleteCloudStore mutation · cloudStoreDeleteInput

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

Test Cloud Store​

See: testCloudStore mutation · cloudStoreTestInput

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

Draft Operations​

Create Draft​

See: createDraft mutation · draftCreateInput

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

Update Draft​

See: updateDraft mutation · draftUpdateInput

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

Delete Draft​

See: deleteDraft mutation · draftDeleteInput

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

See: createDirectLink mutation · directLinkInput

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

See: deleteDirectLink mutation · directLinkDeleteInput

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

Data Operations​

Create Data Stop​

See: createDataStop mutation · DataStopInput

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

Delete Data Stop​

See: deleteDataStop mutation · DataStopInput

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

Webhook Operations​

Create Webhook​

See: createWebhook mutation · WebhookCreateInput

Creates a webhook for event notifications. See Webhook Create Input for example.

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

Input Variables:

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

Update Webhook​

See: updateWebhook mutation · WebhookUpdateInput

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

Delete Webhook​

See: deleteWebhook mutation · webhookDeleteInput

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

Support Operations​

Create Support Ticket​

See: createSupportTicket mutation · supportTicketCreateInput

Creates a support ticket. See Support Ticket Create Input for example.

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

Input Variables:

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

Create Feedback​

See: createFeedback mutation · feedbackCreateInput

Submits feedback. See Feedback Create Input for example.

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

Input Variables:

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

Create Sales Request​

See: createSalesRequest mutation · salesRequestCreateInput

Creates a sales inquiry request.

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

Input Variables:

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

Utility Operations​

Mark As Complete​

See: markAsComplete mutation · markAsCompleteInput

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

PDF To Image​

See: pdfToImage mutation · pdfToImageInput

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

Test SMTP Email​

See: testSMTPEmail mutation · smtpTestInput

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

Save Session​

See: saveSession mutation · sessionInput

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

Swap Roles​

See: swapRoles mutation · swapRolesInput

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

Merge Templates​

See: mergeTemplates mutation · templateMergeInput

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

Copy Template Fields​

See: copyTemplateFields mutation · templateFieldsCopyInput

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

Update Expiring Items​

See: updateExpiringItems mutation · expiringItemUpdateInput

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

Update Billing​

See: updateBilling mutation · billingUpdateInput

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

Cancel Billing​

See: cancelBilling mutation · billingCancelInput

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

Update Signer Field​

See: updateSignerField mutation · signerUpdateInput

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

User Signature Operations​

Create User Signature Element​

See: createUserSignatureElement mutation · userSignatureElementCreateInput

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

Update User Signature Element​

See: updateUserSignatureElement mutation · userSignatureElementUpdateInput

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

Delete User Signature Element​

See: deleteUserSignatureElement mutation · userSignatureElementDeleteInput

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

Template Tag Operations​

Create Template Tag​

See: createTemplateTag mutation · templateTagCreateInput

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

Delete Template Tag​

See: deleteTemplateTag mutation · templateTagDeleteInput

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

Publishing Operations​

Publish To User​

See: publishToUser mutation

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

Publish To Group​

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