Neidio i’r prif gynnwys

Enghreifftiau Mwtaniad

Mae’r enghreifftiau hyn yn dangos syntax GraphQL ar gyfer pob mwtaniad. Am fanylion llawn y meysydd mewnbwn, gweler y tudalennau cyfeirnod mwtaniad unigol a’r tudalennau cyfeirnod mewnbwn.

cyngor

Am strwythurau gwrthrych mewnbwn manwl ac enghreifftiau, gweler Enghreifftiau Mewnbon.

Gweithrediadau Dogfen​

Anfon Dogfen​

Gweler: send mwtaniad · DocumentSendSettingsInput

Yn anfon dogfen ar gyfer llofnodi. Gweler Mewnbwn Gosodiadau Anfon Dogfen am enghraifft lawn.

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

Newidynnau Mewnbon:

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

Dileu Dogfen​

Gweler: cancelDocument mwtaniad · documentCancelInput

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

Copïo Templed​

Gweler: copyTemplate mwtaniad · templateCopyInput

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

Gweithrediadau Templed​

Creu Templed​

Gweler: createTemplate mwtaniad · templateCreateInput

Yn creu templed newydd. Gweler Mewnbwn Creu Templed am enghraifft.

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

Newidynnau Mewnbon:

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

Diweddaru Templed​

Gweler: updateTemplate mwtaniad · templateUpdateInput

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

Archifo Templed​

Gweler: archiveTemplate mwtaniad · templateArchiveInput

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

Creu Elfen Templed​

Gweler: createTemplateElement mwtaniad · templateElementCreateInput

Yn ychwanegu elfen newydd (maes) at dempled. Gweler Mewnbwn Creu Elfen Templed am enghraifft lawn.

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

Newidynnau Mewnbon:

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

Diweddaru Elfen Templed​

Gweler: updateTemplateElement mwtaniad · templateElementUpdateInput

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

Dileu Elfen Templed​

Gweler: deleteTemplateElement mwtaniad · templateElementDeleteInput

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

Creu Rôl Templed​

Gweler: createTemplateRole mwtaniad · templateRoleCreateInput

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

Diweddaru Rôl Templed​

Gweler: updateTemplateRole mwtaniad · templateRoleUpdateInput

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

Dileu Rôl Templed​

Gweler: deleteTemplateRole mwtaniad · templateRoleDeleteInput

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

Gweithrediadau Cysylltiad​

Creu Cysylltiad​

Yn creu cysylltiad newydd. Gweler Mewnbwn Creu Cysylltiad am enghraifft.

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

Newidynnau Mewnbon:

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

Diweddaru Cysylltiad​

Gweler: updateContact mwtaniad · contactUpdateInput

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

Dileu Cysylltiad​

Gweler: deleteContact mwtaniad · deleteContactInput

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

Creu Grŵp Cysylltiadau​

Gweler: createContactGroup mwtaniad · contactGroupCreateInput

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

Diweddaru Grŵp Cysylltiadau​

Gweler: updateContactGroup mwtaniad · contactGroupUpdateInput

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

Dileu Grŵp Cysylltiadau​

Gweler: deleteContactGroup mwtaniad · contactGroupDeleteInput

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

Ychwanegu At Grŵp Cysylltiadau​

Gweler: addToContactGroup mwtaniad · contactGroupAddInput

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

Tynnu Oddi Wrth Grŵp Cysylltiadau​

Gweler: removeFromContactGroup mwtaniad · contactGroupRemoveInput

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

Gweithrediadau Grŵp​

Creu Grŵp​

Gweler: createGroup mwtaniad · groupCreateInput

Yn creu grŵp newydd mewn sefydliad. Gweler Mewnbwn Creu Grŵp am enghraifft.

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

Newidynnau Mewnbon:

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

Diweddaru Grŵp​

Gweler: updateGroup mwtaniad · groupUpdateInput

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

Diweddaru Aelod Grŵp​

Gweler: updateGroupMember mwtaniad · groupMemberUpdateInput

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

Dileu Aelod Grŵp​

Gweler: deleteGroupMember mwtaniad · groupMemberDeleteInput

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

Gweithrediadau Sefydliad​

Creu Sefydliad​

Gweler: createOrganisation mwtaniad · organisationCreateInput

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

Diweddaru Caniatâd Sefydliad​

Gweler: updateOrganisationPermission mwtaniad · organisationPermissionUpdateInput

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

Diweddaru Cadwraeth Sefydliad​

Gweler: updateOrganisationRetention mwtaniad · retentionRulesInput

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

Gweithrediadau Profiad​

Creu Profiad​

Yn creu profiad llofnodi newydd. Gweler Mewnbwn Creu Proffiad am enghraifft lawn.

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

Newidynnau Mewnbon:

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

Diweddaru Profiad​

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

Dileu Profiad​

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

Copïo Profiad​

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

Gweithrediadau Batch​

Anfon Batch​

Gweler: sendBatch mwtaniad · SendBatchInput

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

Anfon Dogfen Batch​

Gweler: sendBatchDocument mwtaniad · SendBatchDocumentInput

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

Dechrau Batch​

Gweler: startBatch mwtaniad · StartBatchInput

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

Anfon Swmp​

Gweler: sendBulk mwtaniad · SendBulkInput

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

Ychwanegu Dogfen Swmp​

Gweler: addBulkDocument mwtaniad · AddBulkDocumentInput

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

Dechrau Swmp​

Gweler: startBulk mwtaniad · StartBulkInput

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

Gweithrediadau Tasg​

Creu Tasg​

Gweler: createTask mwtaniad · CreateTaskInput

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

Gweithrediadau Derbynnydd​

Diweddaru Derbynnydd​

Gweler: updateRecipient mwtaniad · RecipientUpdateInput

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

Ailosod Derbynnydd​

Gweler: resetRecipient mwtaniad · ResetRecipientInput

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

Cysylltu Derbynnydd​

Gweler: contactRecipient mwtaniad · contactRecipientInput

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

Gweithrediadau Defnyddiwr​

Diweddaru Defnyddiwr​

Gweler: updateUser mwtaniad · userUpdateInput

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

Gweler: updateUserConsent mwtaniad · userUpdateConsentInput

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

Gweithrediadau Atodiad​

Creu Atodiad​

Gweler: createAttachment mwtaniad · attachmentCreateInput

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

Dileu Atodiad​

Gweler: deleteAttachment mwtaniad · attachmentDeleteInput

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

Diweddaru Atodiad Diofyn​

Gweler: updateDefaultAttachment mwtaniad · attachmentUpdateDefaultInput

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

Gweithrediadau Amserlen​

Creu Amserlen​

Gweler: createSchedule mwtaniad · scheduleCreateInput

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

Diweddaru Amserlen​

Gweler: updateSchedule mwtaniad · scheduleUpdateInput

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

Copïo Amserlen​

Gweler: copySchedule mwtaniad · scheduleCopyInput

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

Creu Eitem Amserlen​

Gweler: createScheduleItem mwtaniad · scheduleItemCreateInput

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

Diweddaru Eitem Amserlen​

Gweler: updateScheduleItem mwtaniad · scheduleItemUpdateInput

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

Dileu Eitem Amserlen​

Gweler: deleteScheduleItem mwtaniad · scheduleItemDeleteInput

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

Gweithrediadau Neges Safonol​

Creu Neges Safonol​

Gweler: createStandardMessage mwtaniad · standardMessageCreateInput

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

Dileu Neges Safonol​

Gweler: deleteStandardMessage mwtaniad · standardMessageDeleteInput

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

Diweddaru Neges Safonol Diofyn​

Gweler: updateDefaultStandardMessage mwtaniad · standardMessageUpdateDefaultInput

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

Gweithrediadau Gwahoddiad​

Creu Gwahoddiad​

Gweler: createInvitation mwtaniad · invitationCreateInput

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

Dileu Gwahoddiad​

Gweler: deleteInvitation mwtaniad · invitationDeleteInput

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

Gweithrediadau Storfa Cwmwl​

Creu Storfa Cwmwl​

Gweler: createCloudStore mwtaniad · cloudStoreCreateInput

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

Diweddaru Storfa Cwmwl​

Gweler: updateCloudStore mwtaniad · cloudStoreUpdateInput

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

Dileu Storfa Cwmwl​

Gweler: deleteCloudStore mwtaniad · cloudStoreDeleteInput

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

Prawf Storfa Cwmwl​

Gweler: testCloudStore mwtaniad · cloudStoreTestInput

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

Gweithrediadau Drafft​

Creu Drafft​

Gweler: createDraft mwtaniad · draftCreateInput

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

Diweddaru Drafft​

Gweler: updateDraft mwtaniad · draftUpdateInput

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

Dileu Drafft​

Gweler: deleteDraft mwtaniad · draftDeleteInput

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

Gweler: createDirectLink mwtaniad · directLinkInput

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

Gweler: deleteDirectLink mwtaniad · directLinkDeleteInput

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

Gweithrediadau Data​

Creu Stop Data​

Gweler: createDataStop mwtaniad · DataStopInput

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

Dileu Stop Data​

Gweler: deleteDataStop mwtaniad · DataStopInput

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

Gweithrediadau Webhook​

Creu Webhook​

Gweler: createWebhook mwtaniad · WebhookCreateInput

Yn creu webhook ar gyfer hysbysiadau digwyddiadau. Gweler Mewnbwn Creu Webhook am enghraifft.

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

Newidynnau Mewnbon:

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

Diweddaru Webhook​

Gweler: updateWebhook mwtaniad · WebhookUpdateInput

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

Dileu Webhook​

Gweler: deleteWebhook mwtaniad · webhookDeleteInput

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

Gweithrediadau Cymorth​

Creu Tocyn Cymorth​

Gweler: createSupportTicket mwtaniad · supportTicketCreateInput

Yn creu tocyn cymorth. Gweler Mewnbwn Creu Tocyn Cymorth am enghraifft.

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

Newidynnau Mewnbon:

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

Creu Adborth​

Gweler: createFeedback mwtaniad · feedbackCreateInput

Yn cyflwyno adborth. Gweler Mewnbwn Creu Adborth am enghraifft.

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

Newidynnau Mewnbon:

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

Creu Cais Gwerthu​

Gweler: createSalesRequest mwtaniad · salesRequestCreateInput

Yn creu cais ymholiad gwerthu.

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

Newidynnau Mewnbon:

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

Gweithrediadau Defnyddiol​

Marcio Fel Wedi’i Gwblhau​

Gweler: markAsComplete mwtaniad · markAsCompleteInput

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

PDF i Ddelwedd​

Gweler: pdfToImage mwtaniad · pdfToImageInput

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

Profi E-bost SMTP​

Gweler: testSMTPEmail mwtaniad · smtpTestInput

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

Cadw Sesiwn​

Gweler: saveSession mwtaniad · sessionInput

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

Cyfnewid Rolau​

Gweler: swapRoles mwtaniad · swapRolesInput

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

Uno Templediadau​

Gweler: mergeTemplates mwtaniad · templateMergeInput

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

Copïo Meysydd Templed​

Gweler: copyTemplateFields mwtaniad · templateFieldsCopyInput

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

Diweddaru Eitemau Sy’n Dod i Ben​

Gweler: updateExpiringItems mwtaniad · expiringItemUpdateInput

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

Diweddaru Billing​

Gweler: updateBilling mwtaniad · billingUpdateInput

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

Dileu Billing​

Gweler: cancelBilling mwtaniad · billingCancelInput

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

Diweddaru Maes Llofnodiwr​

Gweler: updateSignerField mwtaniad · signerUpdateInput

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

Gweithrediadau Llofnod Defnyddiwr​

Creu Elfen Llofnod Defnyddiwr​

Gweler: createUserSignatureElement mwtaniad · userSignatureElementCreateInput

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

Diweddaru Elfen Llofnod Defnyddiwr​

Gweler: updateUserSignatureElement mwtaniad · userSignatureElementUpdateInput

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

Dileu Elfen Llofnod Defnyddiwr​

Gweler: deleteUserSignatureElement mwtaniad · userSignatureElementDeleteInput

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

Gweithrediadau Tag Templed​

Creu Tag Templed​

Gweler: createTemplateTag mwtaniad · templateTagCreateInput

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

Dileu Tag Templed​

Gweler: deleteTemplateTag mwtaniad · templateTagDeleteInput

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

Gweithrediadau Cyhoeddi​

Cyhoeddi i Ddefnyddiwr​

Gweler: publishToUser mwtaniad

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

Cyhoeddi i Grŵp​

Gweler: publishToGroup mwtaniad

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.