Saltar al contenido principal

Ejemplos de Mutaciones

Estos ejemplos muestran la sintaxis GraphQL para cada mutación. Para detalles completos de los campos de entrada, consulte las páginas de referencia de mutaciones y las páginas de referencia de entradas individuales.

sugerencia

Para estructuras detalladas de objetos de entrada y ejemplos, consulte Ejemplos de Entrada.

Operaciones de Documentos​

Enviar Documento​

Vea: mutación send · DocumentSendSettingsInput

Envía un documento para firma. Vea Ejemplo de Entrada para Envío de Documento para un ejemplo completo.

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

Variables de Entrada:

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

Cancelar Documento​

Vea: mutación cancelDocument · documentCancelInput

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

Copiar Plantilla​

Vea: mutación copyTemplate · templateCopyInput

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

Operaciones con Plantillas​

Crear Plantilla​

Vea: mutación createTemplate · templateCreateInput

Crea una nueva plantilla. Vea Ejemplo de Entrada para Crear Plantilla para un ejemplo.

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

Variables de Entrada:

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

Actualizar Plantilla​

Vea: mutación updateTemplate · templateUpdateInput

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

Archivar Plantilla​

Vea: mutación archiveTemplate · templateArchiveInput

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

Crear Elemento de Plantilla​

Vea: mutación createTemplateElement · templateElementCreateInput

Agrega un nuevo elemento (campo) a una plantilla. Vea Ejemplo de Entrada para Crear Elemento de Plantilla para ejemplo completo.

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

Variables de Entrada:

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

Actualizar Elemento de Plantilla​

Vea: mutación updateTemplateElement · templateElementUpdateInput

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

Eliminar Elemento de Plantilla​

Vea: mutación deleteTemplateElement · templateElementDeleteInput

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

Crear Rol de Plantilla​

Vea: mutación createTemplateRole · templateRoleCreateInput

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

Actualizar Rol de Plantilla​

Vea: mutación updateTemplateRole · templateRoleUpdateInput

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

Eliminar Rol de Plantilla​

Vea: mutación deleteTemplateRole · templateRoleDeleteInput

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

Operaciones de Contactos​

Crear Contacto​

Crea un nuevo contacto. Vea Ejemplo de Entrada para Crear Contacto para un ejemplo.

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

Variables de Entrada:

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

Actualizar Contacto​

Vea: mutación updateContact · contactUpdateInput

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

Eliminar Contacto​

Vea: mutación deleteContact · deleteContactInput

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

Crear Grupo de Contactos​

Vea: mutación createContactGroup · contactGroupCreateInput

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

Actualizar Grupo de Contactos​

Vea: mutación updateContactGroup · contactGroupUpdateInput

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

Eliminar Grupo de Contactos​

Vea: mutación deleteContactGroup · contactGroupDeleteInput

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

Agregar a Grupo de Contactos​

Vea: mutación addToContactGroup · contactGroupAddInput

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

Quitar de Grupo de Contactos​

Vea: mutación removeFromContactGroup · contactGroupRemoveInput

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

Operaciones de Grupos​

Crear Grupo​

Vea: mutación createGroup · groupCreateInput

Crea un nuevo grupo en una organización. Vea Ejemplo de Entrada para Crear Grupo para ejemplo.

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

Variables de Entrada:

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

Actualizar Grupo​

Vea: mutación updateGroup · groupUpdateInput

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

Actualizar Miembro de Grupo​

Vea: mutación updateGroupMember · groupMemberUpdateInput

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

Eliminar Miembro de Grupo​

Vea: mutación deleteGroupMember · groupMemberDeleteInput

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

Operaciones de Organización​

Crear Organización​

Vea: mutación createOrganisation · organisationCreateInput

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

Actualizar Permiso de Organización​

Vea: mutación updateOrganisationPermission · organisationPermissionUpdateInput

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

Actualizar Retención de Organización​

Vea: mutación updateOrganisationRetention · retentionRulesInput

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

Operaciones de Experiencia​

Crear Experiencia​

Crea una nueva experiencia de firma. Vea Ejemplo de Entrada para Crear Experiencia para un ejemplo completo.

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

Variables de Entrada:

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

Actualizar Experiencia​

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

Eliminar Experiencia​

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

Copiar Experiencia​

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

Operaciones por Lote​

Enviar Lote​

Vea: mutación sendBatch · SendBatchInput

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

Enviar Documento de Lote​

Vea: mutación sendBatchDocument · SendBatchDocumentInput

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

Iniciar Lote​

Vea: mutación startBatch · StartBatchInput

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

Enviar en Masa​

Vea: mutación sendBulk · SendBulkInput

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

Agregar Documento en Masa​

Vea: mutación addBulkDocument · AddBulkDocumentInput

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

Iniciar Envío en Masa​

Vea: mutación startBulk · StartBulkInput

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

Operaciones de Tareas​

Crear Tarea​

Vea: mutación createTask · CreateTaskInput

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

Operaciones con Destinatarios​

Actualizar Destinatario​

Vea: mutación updateRecipient · RecipientUpdateInput

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

Restablecer Destinatario​

Vea: mutación resetRecipient · ResetRecipientInput

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

Contactar Destinatario​

Vea: mutación contactRecipient · contactRecipientInput

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

Operaciones de Usuario​

Actualizar Usuario​

Vea: mutación updateUser · userUpdateInput

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

Vea: mutación updateUserConsent · userUpdateConsentInput

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

Operaciones de Adjuntos​

Crear Adjunto​

Vea: mutación createAttachment · attachmentCreateInput

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

Eliminar Adjunto​

Vea: mutación deleteAttachment · attachmentDeleteInput

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

Actualizar Adjunto Predeterminado​

Vea: mutación updateDefaultAttachment · attachmentUpdateDefaultInput

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

Operaciones de Horarios​

Crear Horario​

Vea: mutación createSchedule · scheduleCreateInput

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

Actualizar Horario​

Vea: mutación updateSchedule · scheduleUpdateInput

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

Copiar Horario​

Vea: mutación copySchedule · scheduleCopyInput

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

Crear Elemento de Horario​

Vea: mutación createScheduleItem · scheduleItemCreateInput

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

Actualizar Elemento de Horario​

Vea: mutación updateScheduleItem · scheduleItemUpdateInput

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

Eliminar Elemento de Horario​

Vea: mutación deleteScheduleItem · scheduleItemDeleteInput

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

Operaciones de Mensajes Estándar​

Crear Mensaje Estándar​

Vea: mutación createStandardMessage · standardMessageCreateInput

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

Eliminar Mensaje Estándar​

Vea: mutación deleteStandardMessage · standardMessageDeleteInput

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

Actualizar Mensaje Estándar Predeterminado​

Vea: mutación updateDefaultStandardMessage · standardMessageUpdateDefaultInput

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

Operaciones de Invitaciones​

Crear Invitación​

Vea: mutación createInvitation · invitationCreateInput

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

Eliminar Invitación​

Vea: mutación deleteInvitation · invitationDeleteInput

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

Operaciones de Almacenamiento en la Nube​

Crear Almacenamiento en la Nube​

Vea: mutación createCloudStore · cloudStoreCreateInput

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

Actualizar Almacenamiento en la Nube​

Vea: mutación updateCloudStore · cloudStoreUpdateInput

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

Eliminar Almacenamiento en la Nube​

Vea: mutación deleteCloudStore · cloudStoreDeleteInput

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

Probar Almacenamiento en la Nube​

Vea: mutación testCloudStore · cloudStoreTestInput

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

Operaciones de Borradores​

Crear Borrador​

Vea: mutación createDraft · draftCreateInput

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

Actualizar Borrador​

Vea: mutación updateDraft · draftUpdateInput

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

Eliminar Borrador​

Vea: mutación deleteDraft · draftDeleteInput

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

Vea: mutación createDirectLink · directLinkInput

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

Vea: mutación deleteDirectLink · directLinkDeleteInput

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

Operaciones de Datos​

Crear Detención de Datos​

Vea: mutación createDataStop · DataStopInput

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

Eliminar Detención de Datos​

Vea: mutación deleteDataStop · DataStopInput

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

Operaciones de Webhooks​

Crear Webhook​

Vea: mutación createWebhook · WebhookCreateInput

Crea un webhook para notificaciones de eventos. Vea Ejemplo de Entrada para Crear Webhook para ejemplo.

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

Variables de Entrada:

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

Actualizar Webhook​

Vea: mutación updateWebhook · WebhookUpdateInput

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

Eliminar Webhook​

Vea: mutación deleteWebhook · webhookDeleteInput

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

Operaciones de Soporte​

Crear Ticket de Soporte​

Vea: mutación createSupportTicket · supportTicketCreateInput

Crea un ticket de soporte. Vea Ejemplo de Entrada para Crear Ticket de Soporte para ejemplo.

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

Variables de Entrada:

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

Crear Retroalimentación​

Vea: mutación createFeedback · feedbackCreateInput

Envía retroalimentación. Vea Ejemplo de Entrada para Crear Retroalimentación para ejemplo.

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

Variables de Entrada:

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

Crear Solicitud de Ventas​

Vea: mutación createSalesRequest · salesRequestCreateInput

Crea una solicitud de consulta de ventas.

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

Variables de Entrada:

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

Operaciones Utilitarias​

Marcar Como Completo​

Vea: mutación markAsComplete · markAsCompleteInput

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

PDF a Imagen​

Vea: mutación pdfToImage · pdfToImageInput

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

Probar Correo SMTP​

Vea: mutación testSMTPEmail · smtpTestInput

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

Guardar Sesión​

Vea: mutación saveSession · sessionInput

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

Intercambiar Roles​

Vea: mutación swapRoles · swapRolesInput

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

Fusionar Plantillas​

Vea: mutación mergeTemplates · templateMergeInput

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

Copiar Campos de Plantilla​

Vea: mutación copyTemplateFields · templateFieldsCopyInput

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

Actualizar Elementos que Expiran​

Vea: mutación updateExpiringItems · expiringItemUpdateInput

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

Actualizar Facturación​

Vea: mutación updateBilling · billingUpdateInput

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

Cancelar Facturación​

Vea: mutación cancelBilling · billingCancelInput

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

Actualizar Campo de Firmante​

Vea: mutación updateSignerField · signerUpdateInput

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

Operaciones de Firma de Usuario​

Crear Elemento de Firma de Usuario​

Vea: mutación createUserSignatureElement · userSignatureElementCreateInput

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

Actualizar Elemento de Firma de Usuario​

Vea: mutación updateUserSignatureElement · userSignatureElementUpdateInput

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

Eliminar Elemento de Firma de Usuario​

Vea: mutación deleteUserSignatureElement · userSignatureElementDeleteInput

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

Operaciones de Etiquetas de Plantilla​

Crear Etiqueta de Plantilla​

Vea: mutación createTemplateTag · templateTagCreateInput

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

Eliminar Etiqueta de Plantilla​

Vea: mutación deleteTemplateTag · templateTagDeleteInput

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

Operaciones de Publicación​

Publicar para Usuario​

Vea: mutación publishToUser

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

Publicar para Grupo​

Vea: mutación publishToGroup

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.