Sleamhnú go príomh-ábhar

Samplaí Athraithe

Taispeánann na samplaí seo sintéis GraphQL do gach athrú. Chun sonraí iomlána faoi réimsí ionchuir a fháil, féach ar na leathanaigh tagartha athraithe agus ar na leathanaigh tagartha ionchuir aonair.

leide

Chun struchtúir agus samplaí mionsonraithe d’ábhar ionchuir a fheiceáil, féach ar Samplaí Ionchuir.

Oibríochtaí Doiciméad​

Seol Doiciméad​

Féach: send mutation · DocumentSendSettingsInput

Seolann doiciméad le haghaidh sínithe. Féach ar Ionchur Socruithe Seolta Doiciméad chun sampla iomlán a fheiceáil.

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

Athróga Ionchuir:

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

Cealaigh Doiciméad​

Féach: cancelDocument mutation · documentCancelInput

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

Cóipeáil Téimpléad​

Féach: copyTemplate mutation · templateCopyInput

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

Oibríochtaí Téimpléid​

Cruthaigh Téimpléad​

Féach: createTemplate mutation · templateCreateInput

Cruthaíonn téimpléad nua. Féach ar Ionchur Cruthaithe Téimpléid chun sampla a fheiceáil.

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

Athróga Ionchuir:

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

Nuashonraigh Téimpléad​

Féach: updateTemplate mutation · templateUpdateInput

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

Aibhsigh Téimpléad​

Féach: archiveTemplate mutation · templateArchiveInput

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

Cruthaigh Eilimint Téimpléid​

Féach: createTemplateElement mutation · templateElementCreateInput

Cuir eilimint nua (réimse) le téimpléad. Féach ar Ionchur Cruthaithe Eilimint Téimpléid chun sampla iomlán a fheiceáil.

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

Athróga Ionchuir:

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

Nuashonraigh Eilimint Téimpléid​

Féach: updateTemplateElement mutation · templateElementUpdateInput

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

Scrios Eilimint Téimpléid​

Féach: deleteTemplateElement mutation · templateElementDeleteInput

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

Cruthaigh Ról Téimpléid​

Féach: createTemplateRole mutation · templateRoleCreateInput

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

Nuashonraigh Ról Téimpléid​

Féach: updateTemplateRole mutation · templateRoleUpdateInput

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

Scrios Ról Téimpléid​

Féach: deleteTemplateRole mutation · templateRoleDeleteInput

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

Oibríochtaí Teagmhála​

Cruthaigh Teagmháil​

Cruthaíonn teagmháil nua. Féach ar Ionchur Cruthaithe Teagmhála chun sampla a fheiceáil.

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

Athróga Ionchuir:

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

Nuashonraigh Teagmháil​

Féach: updateContact mutation · contactUpdateInput

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

Scrios Teagmháil​

Féach: deleteContact mutation · deleteContactInput

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

Cruthaigh Grúpa Teagmhála​

Féach: createContactGroup mutation · contactGroupCreateInput

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

Nuashonraigh Grúpa Teagmhála​

Féach: updateContactGroup mutation · contactGroupUpdateInput

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

Scrios Grúpa Teagmhála​

Féach: deleteContactGroup mutation · contactGroupDeleteInput

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

Cuir Le Grúpa Teagmhála​

Féach: addToContactGroup mutation · contactGroupAddInput

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

Bain Amach As Grúpa Teagmhála​

Féach: removeFromContactGroup mutation · contactGroupRemoveInput

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

Oibríochtaí Grúpa​

Cruthaigh Grúpa​

Féach: createGroup mutation · groupCreateInput

Cruthaíonn grúpa nua in eagraíocht. Féach ar Ionchur Cruthaithe Grúpa chun sampla a fheiceáil.

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

Athróga Ionchuir:

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

Nuashonraigh Grúpa​

Féach: updateGroup mutation · groupUpdateInput

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

Nuashonraigh Ball Grúpa​

Féach: updateGroupMember mutation · groupMemberUpdateInput

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

Scrios Ball Grúpa​

Féach: deleteGroupMember mutation · groupMemberDeleteInput

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

Oibríochtaí Eagraíochta​

Cruthaigh Eagraíocht​

Féach: createOrganisation mutation · organisationCreateInput

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

Nuashonraigh Cead Eagraíochta​

Féach: updateOrganisationPermission mutation · organisationPermissionUpdateInput

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

Nuashonraigh Coinneáil Eagraíochta​

Féach: updateOrganisationRetention mutation · retentionRulesInput

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

Oibríochtaí Taithí​

Cruthaigh Taithí​

Cruthaíonn taithí sínithe nua. Féach ar Ionchur Cruthaithe Taithí chun sampla iomlán a fheiceáil.

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

Athróga Ionchuir:

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

Nuashonraigh Taithí​

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

Scrios Taithí​

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

Cóipeáil Taithí​

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

Oibríochtaí Sláintiúla​

Seol Sláthach​

Féach: sendBatch mutation · SendBatchInput

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

Seol Doiciméad Sláintiúil​

Féach: sendBatchDocument mutation · SendBatchDocumentInput

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

Tosaigh Sláthach​

Féach: startBatch mutation · StartBatchInput

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

Seol Iomarcach​

Féach: sendBulk mutation · SendBulkInput

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

Cuir Doiciméad Iomarcach Leis​

Féach: addBulkDocument mutation · AddBulkDocumentInput

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

Tosaigh Iomarcach​

Féach: startBulk mutation · StartBulkInput

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

Oibríochtaí Tasc​

Cruthaigh Tasc​

Féach: createTask mutation · CreateTaskInput

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

Oibríochtaí Faighteora​

Nuashonraigh Faighteora​

Féach: updateRecipient mutation · RecipientUpdateInput

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

Athshocrú Faighteora​

Féach: resetRecipient mutation · ResetRecipientInput

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

Faighteoir Teagmhála​

Féach: contactRecipient mutation · contactRecipientInput

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

Oibríochtaí Úsáideora​

Nuashonraigh Úsáideoir​

Féach: updateUser mutation · userUpdateInput

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

Féach: updateUserConsent mutation · userUpdateConsentInput

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

Oibríochtaí Ceangail​

Cruthaigh Ceangail​

Féach: createAttachment mutation · attachmentCreateInput

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

Scrios Ceangail​

Féach: deleteAttachment mutation · attachmentDeleteInput

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

Nuashonraigh Ceangail Réamhshocraithe​

Féach: updateDefaultAttachment mutation · attachmentUpdateDefaultInput

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

Oibríochtaí Sceideal​

Cruthaigh Sceideal​

Féach: createSchedule mutation · scheduleCreateInput

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

Nuashonraigh Sceideal​

Féach: updateSchedule mutation · scheduleUpdateInput

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

Cóipeáil Sceideal​

Féach: copySchedule mutation · scheduleCopyInput

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

Cruthaigh Eilimint Sceideal​

Féach: createScheduleItem mutation · scheduleItemCreateInput

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

Nuashonraigh Eilimint Sceideal​

Féach: updateScheduleItem mutation · scheduleItemUpdateInput

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

Scrios Eilimint Sceideal​

Féach: deleteScheduleItem mutation · scheduleItemDeleteInput

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

Oibríochtaí Teachtaireachtaí Caighdeánacha​

Cruthaigh Teachtaireacht Chaighdeánach​

Féach: createStandardMessage mutation · standardMessageCreateInput

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

Scrios Teachtaireacht Chaighdeánach​

Féach: deleteStandardMessage mutation · standardMessageDeleteInput

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

Nuashonraigh Teachtaireacht Chaighdeánach Réamhshocraithe​

Féach: updateDefaultStandardMessage mutation · standardMessageUpdateDefaultInput

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

Oibríochtaí Cuireadh​

Cruthaigh Cuireadh​

Féach: createInvitation mutation · invitationCreateInput

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

Scrios Cuireadh​

Féach: deleteInvitation mutation · invitationDeleteInput

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

Oibríochtaí Stór Scamall​

Cruthaigh Stór Scamall​

Féach: createCloudStore mutation · cloudStoreCreateInput

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

Nuashonraigh Stór Scamall​

Féach: updateCloudStore mutation · cloudStoreUpdateInput

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

Scrios Stór Scamall​

Féach: deleteCloudStore mutation · cloudStoreDeleteInput

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

Tástáil Stór Scamall​

Féach: testCloudStore mutation · cloudStoreTestInput

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

Oibríochtaí Dréacht​

Cruthaigh Dréacht​

Féach: createDraft mutation · draftCreateInput

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

Nuashonraigh Dréacht​

Féach: updateDraft mutation · draftUpdateInput

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

Scrios Dréacht​

Féach: deleteDraft mutation · draftDeleteInput

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

Féach: createDirectLink mutation · directLinkInput

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

Féach: deleteDirectLink mutation · directLinkDeleteInput

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

Oibríochtaí Sonraí​

Cruthaigh Stad Sonraí​

Féach: createDataStop mutation · DataStopInput

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

Scrios Stad Sonraí​

Féach: deleteDataStop mutation · DataStopInput

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

Oibríochtaí Webhook​

Cruthaigh Webhook​

Féach: createWebhook mutation · WebhookCreateInput

Cruthaíonn webhook do fógraí imeachtaí. Féach ar Ionchur Cruthaithe Webhook chun sampla a fheiceáil.

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

Athróga Ionchuir:

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

Nuashonraigh Webhook​

Féach: updateWebhook mutation · WebhookUpdateInput

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

Scrios Webhook​

Féach: deleteWebhook mutation · webhookDeleteInput

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

Oibríochtaí Tacaíochta​

Cruthaigh Ticéad Tacaíochta​

Féach: createSupportTicket mutation · supportTicketCreateInput

Cruthaíonn ticéad tacaíochta. Féach ar Ionchur Cruthaithe Thicéad Tacaíochta le haghaidh sampla.

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

Athróga Ionchuir:

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

Cruthaigh Aiseolas​

Féach: createFeedback mutation · feedbackCreateInput

Seolann aiseolas. Féach ar Ionchur Cruthaithe Aiseolais le haghaidh sampla.

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

Athróga Ionchuir:

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

Cruthaigh Iarraidh Díolacháin​

Féach: createSalesRequest mutation · salesRequestCreateInput

Cruthaíonn iarratas fiosrúcháin díolacháin.

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

Athróga Ionchuir:

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

Oibríochtaí Úsáide​

Marcáil Mar Dhliteanach​

Féach: markAsComplete mutation · markAsCompleteInput

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

PDF Go Íomha​

Féach: pdfToImage mutation · pdfToImageInput

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

Tástáil Ríomhphost SMTP​

Féach: testSMTPEmail mutation · smtpTestInput

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

Sábháil Seisiún​

Féach: saveSession mutation · sessionInput

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

Malartú Ról​

Féach: swapRoles mutation · swapRolesInput

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

Comhcheangail Téimpléid​

Féach: mergeTemplates mutation · templateMergeInput

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

Cóipeáil Réimsí Téimpléid​

Féach: copyTemplateFields mutation · templateFieldsCopyInput

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

Nuashonraigh Eilimintí Ag Éirí As Éifeacht​

Féach: updateExpiringItems mutation · expiringItemUpdateInput

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

Nuashonraigh Billeáil​

Féach: updateBilling mutation · billingUpdateInput

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

Cealaigh Billeáil​

Féach: cancelBilling mutation · billingCancelInput

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

Nuashonraigh Réimse Sínitheora​

Féach: updateSignerField mutation · signerUpdateInput

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

Oibríochtaí Síniú Úsáideora​

Cruthaigh Eilimint Síniú Úsáideora​

Féach: createUserSignatureElement mutation · userSignatureElementCreateInput

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

Nuashonraigh Eilimint Síniú Úsáideora​

Féach: updateUserSignatureElement mutation · userSignatureElementUpdateInput

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

Scrios Eilimint Síniú Úsáideora​

Féach: deleteUserSignatureElement mutation · userSignatureElementDeleteInput

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

Oibríochtaí Lipéad Téimpléid​

Cruthaigh Lipéad Téimpléid​

Féach: createTemplateTag mutation · templateTagCreateInput

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

Scrios Lipéad Téimpléid​

Féach: deleteTemplateTag mutation · templateTagDeleteInput

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

Oibríochtaí Foilsitheoireachta​

Foilsigh Do Úsáideoir​

Féach: publishToUser mutation

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

Foilsigh Do Ghrúpa​

Féach: 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.