Mutation Examples

tip

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

Document Operations

Send Document

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

mutation sendSingleDocument {
  send(
    input: {
      title: "Example Template"
      templateId: "dHBsYTZkZTA1ZDMtMTE4YS0xMWYxvWE1M2MtMDY5NzZlZmU0MzIx"
      groupId: "Z3JwZGVtVGbzE="
      tag: ""
      pdfPassword: ""
      retainPdfPassword: true
      allowPrinting: false
      allowCopying: false
      sequentialSigning: true
      documentCCEmail: []
      senderFields: []
      participantFields: [
        {
          id: "ZWxlNzEzYjU1NjctODM3Yy00ODE5LkExOGUtY2ZjY2M0NTY3MWJj"
          value: ""
        }
        {
          id: "ZWxlM2FjYzg0NWQtYjMzZC00MzVmLTliM2EtZmU0Yzg2NmIwYmFk"
          value: ""
        }
        {
          id: "ZWxlZDk2YzFiMDItZTk1ZS00OTYzLWE4ZTgtZjQ1YzQ2N2EwZjQ2"
          value: ""
        }
        {
          id: "ZWxlNDZkMGE0ZjQtODk3Yi00YmEwLTk0NzYtMDIwYzAzZDQwM2Ni"
          value: ""
        }
      ]
      recipients: [
        {
          id: "cm9sYTZkZTI5YzItMTE4YS0xMWYxLWE1M2MtMDY5NzZlZmU0MzIx"
          order: 0
          signerIndex: 1
          role: ""
          roleId: "cm9sYTZkZTI5YzItMTE4YS0xMWYxLWE1M2MtMDY5NzZlZmU0MzIx"
          experience: "ZXhwZGVtbzE="
          firstName: "Alex"
          phoneNumber: ""
          attachments: []
          lastName: "Weinle"
          email: "alex@legalesign.test"
          scheduleId: "c2NoNzE0"
          expiryDate: null
          timeZone: "Europe/London"
          skipped: false
        },
        {
          id: "cm9sYTg4YTI1YTMtMTZmYS0xMWYxLWE1MzAtMDY5NzZlZmU0MzIx"
          order: 1
          signerIndex: 2
          role: ""
          roleId: "cm9sYTg4YTI1YTMtMTZmYS0xMWYxLWE1MzAtMDY5NzZlZmU0MzIx"
          experience: "ZXhwZGVtbzE="
          firstName: "Alex"
          phoneNumber: ""
          attachments: []
          lastName: "Weinle"
          email: "alex2@legalesign.test"
          scheduleId: "c2NoNzE0"
          expiryDate: null
          timeZone: "Europe/London"
          skipped: false
        }
      ]
    }
  )
}

To break down that very important mutation a little. See this article dedicated to the send mutation. Getting to Send

Archive Document

mutation ArchiveDocument($input: documentArchiveInput!) {
  archiveDocument(input: $input)
}

Copy Template

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

Template Operations

Create Template

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

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

Input Variables:

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

Update Template

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

Archive Template

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

Create Template Element

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

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

Delete Template Element

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

Create Template Role

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

Update Template Role

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

Delete Template Role

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

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

Delete Contact

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

Create Contact Group

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

Update Contact Group

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

Delete Contact Group

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

Add To Contact Group

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

Remove From Contact Group

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

Group Operations

Create Group

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

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

Update Group Member

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

Delete Group Member

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

Organisation Operations

Create Organisation

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

Update Organisation Permission

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

Update Organisation Retention

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

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

Send Batch Document

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

Start Batch

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

Send Bulk

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

Add Bulk Document

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

Start Bulk

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

Task Operations

Create Task

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

Recipient Operations

Update Recipient

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

Reset Recipient

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

Contact Recipient

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

User Operations

Update User

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

Update User Consent

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

Attachment Operations

Create Attachment

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

Delete Attachment

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

Update Default Attachment

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

Schedule Operations

Create Schedule

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

Update Schedule

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

Copy Schedule

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

Create Schedule Item

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

Update Schedule Item

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

Delete Schedule Item

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

Standard Message Operations

Create Standard Message

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

Delete Standard Message

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

Update Default Standard Message

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

Invitation Operations

Create Invitation

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

Delete Invitation

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

Cloud Store Operations

Create Cloud Store

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

Update Cloud Store

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

Delete Cloud Store

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

Test Cloud Store

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

Draft Operations

Create Draft

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

Update Draft

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

Delete Draft

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

Direct Link Operations

Create Direct Link

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

Delete Direct Link

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

Data Operations

Create Data Stop

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

Delete Data Stop

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

Webhook Operations

Create Webhook

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

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

Delete Webhook

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

Support Operations

Create Support Ticket

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

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@company.com"
  }
}

Create Sales Request

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@company.com"
  }
}

Utility Operations

Mark As Complete

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

PDF To Image

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

Test SMTP Email

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

Save Session

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

Swap Roles

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

Merge Templates

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

Copy Template Fields

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

Update Expiring Items

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

Update Billing

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

Cancel Billing

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

Update Signer Field

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

User Signature Operations

Create User Signature Element

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

Update User Signature Element

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

Delete User Signature Element

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

Template Tag Operations

Create Template Tag

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

Delete Template Tag

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

Publishing Operations

Publish To User

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

Publish To Group

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