Docusign
Docusign permite a las organizaciones crear, confirmar y administrar sus contratos en todo el ciclo de vida del contrato. Los clientes pueden acelerar los ingresos, reducir el riesgo y desbloquear el valor de los contratos que ejecutan su negocio.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Estándar | Todas las regiones de Power Automate excepto las siguientes: - China Cloud operado por 21Vianet |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Estándar | Todas las regiones de Power Apps excepto las siguientes: - China Cloud operado por 21Vianet |
| Power Automate | Estándar | Todas las regiones de Power Automate excepto las siguientes: - China Cloud operado por 21Vianet |
| Contacto | |
|---|---|
| Nombre | docusign |
| URL | https://support.docusign.com |
| Metadatos del conector | |
|---|---|
| Publicador | DocuSign, Inc. |
| Sitio web | https://www.docusign.com |
| Directiva de privacidad | https://www.docusign.com/company/privacy-policy |
| Categorías | Contenido y archivos; Productividad |
Title
DocuSign ayuda a las organizaciones a conectarse y automatizar cómo preparan, firman, actúan y administran contratos. El conector de demostración de DocuSign solo se conecta a entornos de demostración de DocuSign, pero ofrece la misma funcionalidad que el conector de DocuSign normal. Los documentos de un entorno de demostración de DocuSign no se enlazan legalmente. Para todos los usos que no son de demostración, use el conector docuSign normal.
Prerrequisitos
Para usar el desencadenador Connect en esta integración, DocuSign Connect debe estar habilitado en la cuenta de DocuSign. No está habilitado de forma predeterminada. Una vez habilitada, se puede acceder a la página Configuración de conexión desde la aplicación web de administración de DocuSign. El uso del desencadenador Connect en esta integración registrará automáticamente el webhook automáticamente.
Obtención de credenciales
Para probar el conector, use una cuenta demo:
- Vaya a https://developers.docusign.com/.
- Cree una cuenta de espacio aislado.
Estas son diferentes de las evaluaciones gratuitas en que nunca expiran, tienen 90% de nuestras características de cuenta de pago y ninguno de los documentos enviados a través de DEMO son legalmente vinculantes ((https://support.docusign.com/en/articles/Free-account-vs-Developer-account).
Documentación del conector
Para obtener documentación detallada sobre el conector, consulte https://support.docusign.com/en/guides/DocuSign-eSignature-for-Microsoft-Power-Automate
Problemas conocidos y limitaciones
Para problemas con DocuSign, pruebe primero este vínculo: https://support.docusign.com/en/articles/How-Do-I-Open-a-Case-in-the-DocuSign-Support-Center.
Instrucciones de implementación
Use estas instrucciones para implementar este conector como conector personalizado en Microsoft Power Automate y Power Apps.
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 250 | 60 segundos |
Acciones
| Actualizar campo personalizado de sobre |
Valor de actualización para el campo personalizado de sobre especificado |
| Actualizar campos de formulario de generación de documentos desde sobre |
Actualizar campos de formulario de generación de documentos desde sobre |
| Actualizar destinatario en un sobre |
Actualizar destinatario en un sobre |
| Actualizar los valores de la pestaña destinatario en un sobre |
Actualizar los valores de la pestaña destinatario en un sobre |
| Actualizar pestañas de relleno previo de sobre |
Actualizar valores para una lista de pestañas de prerrellenar |
| Agregar destinatario a un sobre (V2) |
Agregue el destinatario a un sobre. |
| Agregar documentos a un sobre |
Agregue documentos a un sobre. |
| Agregar el tipo de verificación a un destinatario |
Agregue el tipo de verificación a un destinatario. |
| Agregar pestañas para un destinatario en un sobre |
Agregar pestañas para un destinatario en un sobre |
| Agregar recordatorios para un sobre |
Agregar recordatorios para un sobre |
| Anulación del sobre |
Anula el sobre. |
| Aplicación de una plantilla a documentos |
Aplicación de una plantilla a documentos |
| Copilot for Sales: Enumeración de sobres |
Copilot for Sales: Los sobres de lista devuelven información sobre los contratos docusign, como título, documentos, destinatarios, estado del contrato, nombre del remitente y dirección URL del contrato. El complemento puede controlar solicitudes como mostrarme todos mis contratos que necesito firmar o cuál es el estado del contrato de pedido de venta. |
| Copilot for Sales: Obtener resumen de correo electrónico |
Esta acción obtiene información adicional sobre las ventas que se mostrará en el resumen de correo electrónico de C4S dentro del resumen de Outlook. La acción mejora las habilidades existentes del copiloto de ventas. |
| Copilot for Sales: Obtener ventas clave |
Esta acción obtiene perspectivas adicionales de ventas que se mostrarán en la tarjeta C4S de información clave sobre ventas en Outlook Sidecar. La acción mejora las aptitudes existentes de copilot para ventas |
| Copilot: Enumerar sobres |
Esta acción devuelve los sobres de Docusign pertinentes en función del estado del sobre, el intervalo de fechas, el nombre del destinatario, la dirección de correo electrónico del destinatario, el título del sobre, el nombre del documento o el valor de campo personalizado del sobre. La salida es el título, la descripción, el identificador de sobre, los nombres de documento, los nombres de remitente, el estado del sobre, la fecha de estado, la fecha enviada y una dirección URL del sobre que se puede usar como vínculo para ver el sobre en Docusign. |
| Copilot: Obtener actividades relacionadas |
Esta acción obtiene información adicional de ventas relacionada con un registro CRM que se mostrará en la tarjeta de resumen de registros C4S. La acción mejora las habilidades existentes del copiloto de ventas. |
| Copilot: Obtener registros relacionados |
Esta acción obtiene registros relacionados con un registro CRM. La acción mejora las aptitudes existentes de Copilot for Sales. |
| Creación de sobre mediante plantilla |
Cree un nuevo sobre mediante una plantilla especificada. |
| Creación de sobre mediante plantilla con destinatarios y pestañas |
Creación de sobre mediante plantilla con destinatarios y pestañas |
| Creación de sobre mediante plantillas compuestas |
Creación de sobre mediante plantillas compuestas |
| Creación de una lista de envío masiva |
Creación de una lista de envío masiva |
| Crear sobre |
Cree un nuevo sobre en blanco. |
| EN DESUSO: Agregar destinatario a un sobre |
Agregue el destinatario a un sobre. |
| EN DESUSO: Creación de sobre mediante plantilla |
Cree un nuevo sobre mediante una plantilla especificada. |
| EN DESUSO: Creación de sobre mediante plantilla con destinatarios |
Cree un nuevo sobre mediante una plantilla especificada y especifique destinatarios. |
| EN DESUSO: Obtener documentos del sobre |
Obtener documentos del sobre |
| Enumerar destinatarios del sobre |
Enumerar destinatarios del sobre |
| Enumerar documentos de un sobre |
Enumerar documentos de un sobre |
| Enumerar documentos de una plantilla |
Enumerar documentos de una plantilla |
| Envío de sobre |
Envíe un sobre existente. |
| Generar dirección URL de firma incrustada (V2) |
Generar dirección URL de firma incrustada (V2) |
| Generar dirección URL de firma incrustada [EN DESUSO] |
Generar dirección URL de firma insertada |
| Generar dirección URL del remitente incrustado |
Generar dirección URL del remitente incrustado |
| Iniciar sesión |
Iniciar sesión |
| Inicio del flujo de trabajo de Docusign Maestro |
Inicio del flujo de trabajo de Docusign Maestro |
| Mostrar número de compilación (solo para referencia). No incluya en un flujo para su ejecución). |
Identificador de la compilación implementada actualmente. |
| Obtención de campos de formulario de generación de documentos a partir del sobre |
Obtención de campos de formulario de generación de documentos a partir del sobre |
| Obtención de campos personalizados de documentos a partir del sobre |
Obtención de campos personalizados de documentos a partir del sobre |
| Obtención de información de campo personalizada del sobre |
Obtención de información de campo personalizada del sobre |
| Obtención de información del destinatario del sobre |
Obtención de información del destinatario del sobre |
| Obtención de pestañas de destinatarios del sobre |
Obtención de pestañas de destinatarios del sobre |
| Obtención de pestañas de documento de la plantilla |
Obtención de pestañas de documento de la plantilla |
| Obtener documentos de un sobre |
Obtener documentos de un sobre |
| Obtener información del documento del sobre |
Obtener información del documento del sobre |
| Obtener información para la pestaña destinatario |
Devuelve el valor de la pestaña para el destinatario especificado. |
| Obtener la lista de eventos de auditoría |
Obtener la lista de eventos de auditoría |
| Obtener pestañas de documento del sobre |
Obtener pestañas de documento del sobre |
| Plantillas de lista |
Enumerar plantillas para una cuenta específica. |
| Quitar destinatario de un sobre |
Quitar destinatario de un sobre |
| Reenviar el sobre |
Esta acción reenvía un sobre docusign o envía un aviso a los destinatarios que necesitan firmar un acuerdo de Docusign basado en un EnvelopeId proporcionado. |
| Sobre de envío masivo mediante plantilla |
Sobre de envío masivo mediante plantilla |
| Sobres de lista |
Esta acción devuelve los sobres de Docusign pertinentes en función del estado del sobre, el intervalo de fechas, el nombre del destinatario, la dirección de correo electrónico del destinatario, el título del sobre, el nombre del documento o el valor de campo personalizado del sobre. La salida es el título, la descripción, el identificador de sobre, los nombres de documento, los nombres de remitente, el estado del sobre, la fecha de estado, la fecha enviada y una dirección URL del sobre que se puede usar como vínculo para ver el sobre en Docusign. |
Actualizar campo personalizado de sobre
Valor de actualización para el campo personalizado de sobre especificado
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Id. de campo
|
fieldId | True | string |
Id. de campo personalizado |
|
Tipo de campo
|
fieldType | True | string |
Tipo de campo personalizado |
|
Nombre
|
name | True | string |
Nombre de campo personalizado |
|
Importancia
|
value | True | string |
Valor de campo personalizado |
Devoluciones
Actualizar campos de formulario de generación de documentos desde sobre
Actualizar campos de formulario de generación de documentos desde sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Id. de sobre |
|
GUID del documento
|
documentGuid | True | string |
GUID del documento |
|
Tipo
|
fieldType | string |
Elija el tipo de campo de generación de documentos que se va a actualizar. |
|
|
Nombre
|
name | string |
Escriba el nombre del campo o el nombre de la columna de tabla. |
|
|
Importancia
|
value | string |
Escriba los datos del campo. |
|
|
: Nombre de tabla
|
tableName | string |
Necesario para "Fila de tabla". Escriba el nombre de la tabla. |
|
|
: fila de tabla
|
rowNumber | string |
Necesario para "Fila de tabla". Escriba el número de fila. |
Actualizar destinatario en un sobre
Actualizar destinatario en un sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Id. de destinatario
|
recipientId | True | string |
Id. de destinatario |
|
Tipo de firma
|
signatureType | string |
Tipos de firma basada en estándares (SBS) de DocuSign. |
|
|
Tipo de destinatario
|
recipientType | True | string |
Tipo de destinatario |
|
Id. de usuario de cliente
|
clientUserId | string |
Identificador de usuario de cliente para el firmante insertado |
|
|
Dirección URL de inicio del destinatario incrustado
|
embeddedRecipientStartURL | string |
Cadena de dirección URL proporcionada por el remitente para redirigir un destinatario incrustado. |
|
|
Orden de firma
|
routingOrder | string |
Orden de firma del destinatario. |
|
|
Idioma de notificación por correo electrónico
|
emailNotificationLanguage | string |
Idioma de la notificación por correo electrónico. |
|
|
Asunto de notificación por correo electrónico
|
emailNotificationSubject | string |
Asunto de la notificación por correo electrónico. |
|
|
Cuerpo de notificación por correo electrónico
|
emailNotificationBody | string |
Cuerpo de la notificación por correo electrónico. |
|
|
Nota:
|
note | string |
Nota personalizada para el destinatario. |
|
|
Nombre del rol
|
roleName | string |
Nombre de rol asociado al destinatario. |
|
|
Código de país de SMS
|
countryCode | integer |
En el caso de las notificaciones por SMS, el código de país, sin signo + inicial. |
|
|
Número de teléfono SMS
|
phoneNumber | integer |
Se requiere un correo electrónico de firmante o un teléfono SMS. Excluir código de país para el número de teléfono. |
|
|
Grupo de firma
|
signingGroupId | string |
Grupo de firma |
|
|
detalles del tipo de destinatario seleccionado
|
additionalRecipientParams | dynamic |
Detalles del tipo de destinatario seleccionado. |
Devoluciones
- Body
- Signer
Actualizar los valores de la pestaña destinatario en un sobre
Actualizar los valores de la pestaña destinatario en un sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Destinatario
|
recipientId | True | string |
Id. de destinatario |
|
Tipo
|
tabType | string |
Tipo de pestaña |
|
|
Id
|
tabId | string |
Id |
|
|
Importancia
|
value | string |
Importancia |
Actualizar pestañas de relleno previo de sobre
Actualizar valores para una lista de pestañas de prerrellenar
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Id. de documento
|
documentId | True | string |
Id. de documento |
|
Tipo
|
tabType | string |
Tipo |
|
|
Id
|
tabId | string |
Id |
|
|
Importancia
|
value | string |
Importancia |
Agregar destinatario a un sobre (V2)
Agregue el destinatario a un sobre.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Tipo de destinatario
|
recipientType | True | string |
Tipo de destinatario |
|
Id. de usuario de cliente
|
clientUserId | string |
Identificador de usuario de cliente para el firmante insertado |
|
|
Dirección URL de inicio del destinatario incrustado
|
embeddedRecipientStartURL | string |
Cadena de dirección URL proporcionada por el remitente para redirigir un destinatario incrustado. |
|
|
Orden de firma
|
routingOrder | string |
Orden de firma del destinatario. |
|
|
Idioma de notificación por correo electrónico
|
emailNotificationLanguage | string |
Idioma de la notificación por correo electrónico. |
|
|
Asunto de notificación por correo electrónico
|
emailNotificationSubject | string |
Asunto de la notificación por correo electrónico. |
|
|
Cuerpo de notificación por correo electrónico
|
emailNotificationBody | string |
Cuerpo de la notificación por correo electrónico. |
|
|
Nota:
|
note | string |
Nota personalizada para el destinatario. |
|
|
Nombre del rol
|
roleName | string |
Nombre de rol asociado al destinatario. |
|
|
Código de país de SMS
|
countryCode | integer |
En el caso de las notificaciones por SMS, el código de país, sin signo + inicial. |
|
|
Número de teléfono SMS
|
phoneNumber | integer |
Se requiere un correo electrónico de firmante o un teléfono SMS. Excluir código de país para el número de teléfono. |
|
|
Grupo de firma
|
signingGroupId | string |
Grupo de firma |
|
|
Tipo de firma
|
signatureType | string |
Tipos de firma basada en estándares (SBS) de DocuSign. |
|
|
Flujo de trabajo de comprobación
|
workflowId | string |
Los flujos de trabajo de IDV con tipos de firma de lápiz deben seleccionarse aquí. |
|
|
detalles del tipo de destinatario seleccionado
|
additionalRecipientParams | dynamic |
Detalles del tipo de destinatario seleccionado. |
Devoluciones
- Body
- Signer
Agregar documentos a un sobre
Agregue documentos a un sobre.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Document Base64 *
|
documentBase64 | True | string |
Base64 del contenido del documento |
|
Tipo de documento *
|
fileExtension | True | string |
pdf, docx, etc. |
|
Nombre del documento *
|
name | True | string |
nombre del documento |
|
Transformar campos pdf
|
transformPdfFields | string |
Falso |
|
|
Asignar pestañas al destinatario
|
assignTabsToRecipientId | string |
Id. de destinatario |
Devoluciones
- Body
- AddDocumentsResponse
Agregar el tipo de verificación a un destinatario
Agregue el tipo de verificación a un destinatario.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Id. de destinatario
|
recipientId | True | string |
Id. de destinatario |
|
Tipo de destinatario
|
recipientType | True | string |
Tipo de destinatario |
|
Tipo de verificación
|
verificationType | True | string |
Tipo de verificación |
|
Datos de destinatarios adicionales
|
additionalRecipientData | dynamic |
Datos de destinatarios adicionales. |
Agregar pestañas para un destinatario en un sobre
Agregar pestañas para un destinatario en un sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Destinatario
|
recipientId | True | string |
Id. de destinatario |
|
Tipo de pestaña
|
tabType | True | string |
Tipo de pestaña |
|
detalles de la pestaña
|
tabDetails | True | dynamic |
Detalles de la pestaña de anclaje seleccionada. |
Devoluciones
Agregar recordatorios para un sobre
Agregar recordatorios para un sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Recordatorio habilitado
|
reminderEnabled | True | boolean |
Cuando se establece en false, los avisos están deshabilitados. El valor predeterminado es false |
|
Retraso del aviso
|
reminderDelay | True | string |
Agregue el número de días después del cual el destinatario recibe el correo electrónico de aviso. |
|
Frecuencia de recordatorio
|
reminderFrequency | True | string |
Agregue el número de días entre los correos electrónicos de recordatorio. |
|
Expirar después de
|
expireAfter | string |
Agregue el número de días antes de la expiración. |
Devoluciones
- Body
- AddRemindersResponse
Anulación del sobre
Anula el sobre.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Motivo de void
|
voidedReason | True | string |
Motivo anulado |
Devoluciones
- response
- object
Aplicación de una plantilla a documentos
Aplicación de una plantilla a documentos
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Id. de sobre
|
envelopeId | True | string |
Id. de sobre |
|
Template
|
templateId | True | string |
Template |
|
Conservar el destinatario de la plantilla
|
preserve_template_recipient | string |
Falso |
|
|
Id. de documento
|
documentId | True | string |
Id. de documento |
|
Página de inicio del documento
|
documentStartPage | True | string |
Página de inicio del documento |
|
Página final del documento
|
documentEndPage | True | string |
Página final del documento |
Copilot for Sales: Enumeración de sobres
Copilot for Sales: Los sobres de lista devuelven información sobre los contratos docusign, como título, documentos, destinatarios, estado del contrato, nombre del remitente y dirección URL del contrato. El complemento puede controlar solicitudes como mostrarme todos mis contratos que necesito firmar o cuál es el estado del contrato de pedido de venta.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del destinatario
|
recipientName | string |
Esta acción enumera los sobres basados en el nombre del destinatario. |
|
|
EmailId de destinatario
|
recipientEmailId | string |
Esta acción enumera los sobres basados en el identificador de correo electrónico del destinatario. |
|
|
Asunto del sobre
|
envelopeTitle | string |
Esta acción enumera sobres según el asunto del correo electrónico del sobre. |
|
|
Nombre de campo personalizado
|
customFieldName | string |
Esta acción enumera los sobres basados en un nombre de sus campos personalizados. |
|
|
Valor de campo personalizado
|
customFieldValue | string |
Esta acción enumera los sobres basados en un valor de sus campos personalizados. |
|
|
Estado del sobre
|
envelopeStatus | string |
Esta acción enumera sobres en función del estado del sobre |
|
|
Carpeta
|
folder_ids | string |
En esta acción se enumeran los sobres en función de varios estados del sobre. |
|
|
Ordenar por
|
order_by | string |
Esta acción ordena sobres en función de una propiedad específica. |
|
|
Arriba
|
top | integer |
Sobres superiores que se van a devolver |
|
|
Omitir
|
skip | integer |
Sobres que se van a omitir |
|
|
Fecha de inicio
|
startDateTime | date-time |
Escriba la fecha y hora de inicio en el formato: 2017-05-02T01:44Z |
|
|
Fecha de finalización
|
endDateTime | date-time |
Escriba la fecha y hora de finalización en el formato: 2017-05-02T01:44Z |
Devoluciones
Copilot for Sales: Obtener resumen de correo electrónico
Esta acción obtiene información adicional sobre las ventas que se mostrará en el resumen de correo electrónico de C4S dentro del resumen de Outlook. La acción mejora las habilidades existentes del copiloto de ventas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
recordType | string |
Esta entrada identifica el tipo de registro en CRM que está relacionado con el correo electrónico resumido. |
|
|
Id. de registro
|
recordId | string |
Esta entrada proporciona el identificador único del registro CRM que está relacionado con el correo electrónico resumido. |
|
|
Tipo de CRM
|
crmType | string |
Esta entrada indica el tipo de CRM en el que existe el registro relacionado con el correo electrónico resumido. |
|
|
DIRECCIÓN URL de la organización de CRM
|
crmOrgUrl | string |
Esta entrada indica la dirección URL del entorno de CRM en el que existe el registro relacionado con el correo electrónico resumido. |
|
|
Direcciones de correo electrónico separadas por comas
|
emailContacts | True | string |
Esta entrada indica una lista de todos los correos electrónicos de participantes pertinentes en el subproceso de correo electrónico actual. |
|
Arriba
|
top | integer |
Esta entrada indica el número de conclusiones que se van a capturar. |
|
|
Omitir
|
skip | integer |
Esta entrada indica el número de elementos que se van a omitir al capturar información. |
Devoluciones
- Body
- EmailSummaryResponse
Copilot for Sales: Obtener ventas clave
Esta acción obtiene perspectivas adicionales de ventas que se mostrarán en la tarjeta C4S de información clave sobre ventas en Outlook Sidecar. La acción mejora las aptitudes existentes de copilot para ventas
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
recordType | True | string |
Esta entrada identifica el tipo de registro en CRM para el que se solicita información de ventas clave. |
|
Id. de registro
|
recordId | True | string |
Esta entrada proporciona el identificador único del registro CRM para el que se solicita información de ventas clave. |
|
Fecha de inicio
|
startDateTime | date-time |
Escriba la fecha y hora de inicio en el formato: 2017-05-02T01:44Z |
|
|
Arriba
|
top | integer |
Este parámetro indica el número de resúmenes de ventas que se van a obtener. |
|
|
Omitir
|
skip | integer |
Esta entrada indica el número de elementos que se van a omitir al obtener los aspectos destacados de ventas. |
|
|
Tipo de CRM
|
crmType | string |
Esta entrada indica el tipo de CRM en el que existe el registro CRM, para el que se solicita información de ventas clave. |
|
|
DIRECCIÓN URL de la organización de CRM
|
crmOrgUrl | string |
Esta entrada indica la dirección URL del entorno de CRM en el que existe el registro CRM, para el que se solicita información de ventas clave. |
Devoluciones
- Body
- KeySalesResponse
Copilot: Enumerar sobres
Esta acción devuelve los sobres de Docusign pertinentes en función del estado del sobre, el intervalo de fechas, el nombre del destinatario, la dirección de correo electrónico del destinatario, el título del sobre, el nombre del documento o el valor de campo personalizado del sobre. La salida es el título, la descripción, el identificador de sobre, los nombres de documento, los nombres de remitente, el estado del sobre, la fecha de estado, la fecha enviada y una dirección URL del sobre que se puede usar como vínculo para ver el sobre en Docusign.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Nombre del destinatario
|
recipientName | string |
Esta acción enumera los sobres basados en el nombre del destinatario. |
|
|
EmailId de destinatario
|
recipientEmailId | string |
Esta acción enumera los sobres basados en el identificador de correo electrónico del destinatario. |
|
|
Asunto del sobre
|
envelopeTitle | string |
Esta acción enumera sobres según el asunto del correo electrónico del sobre. |
|
|
Nombre de campo personalizado
|
customFieldName | string |
Esta acción enumera los sobres basados en un nombre de sus campos personalizados. |
|
|
Valor de campo personalizado
|
customFieldValue | string |
Esta acción enumera los sobres basados en un valor de sus campos personalizados. |
|
|
Estado del sobre
|
envelopeStatus | string |
Esta acción enumera sobres en función del estado del sobre |
|
|
Carpeta
|
folder_ids | string |
En esta acción se enumeran los sobres en función de varios estados del sobre. |
|
|
Ordenar por
|
order_by | string |
Esta acción ordena sobres en función de una propiedad específica. |
|
|
Arriba
|
top | integer |
Sobres superiores que se van a devolver |
|
|
Omitir
|
skip | integer |
Sobres que se van a omitir |
|
|
Fecha de inicio
|
from_date | date-time |
Escriba '' cuando el usuario no proporcione ningún valor. Escriba la fecha y hora de inicio en el patrón o formato: 2017-05-02T01:44Z. |
|
|
Fecha de finalización
|
to_date | date-time |
Escriba '' cuando el usuario no proporcione ningún valor. Escriba la fecha y hora de finalización en el patrón o formato: 2017-05-02T01:44Z. |
Devoluciones
Copilot: Obtener actividades relacionadas
Esta acción obtiene información adicional de ventas relacionada con un registro CRM que se mostrará en la tarjeta de resumen de registros C4S. La acción mejora las habilidades existentes del copiloto de ventas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
recordType | True | string |
Esta entrada indica el tipo de entidad o objeto en CRM para el que se solicita información. |
|
Id. de registro
|
recordId | True | string |
Esta entrada indica el identificador único del registro CRM para el que se solicitan conclusiones. |
|
Fecha de inicio
|
startDateTime | date-time |
Esta entrada indica la fecha y hora de inicio de la información solicitada. |
|
|
Fecha de finalización
|
endDateTime | date-time |
Esta entrada indica la fecha y hora de finalización de la información solicitada. |
|
|
Arriba
|
top | integer |
Esta entrada indica el número de conclusiones que se van a capturar. |
|
|
Omitir
|
skip | integer |
Esta entrada indica el número de conclusiones que se van a omitir. |
|
|
Tipo de CRM
|
crmType | string |
Esta entrada indica el tipo de CRM en el que existe el registro CRM, para el que se solicitan conclusiones. |
|
|
DIRECCIÓN URL de la organización de CRM
|
crmOrgUrl | string |
Esta entrada indica la dirección URL del entorno de CRM en el que existe el registro CRM, para el que se solicita información detallada. |
Devoluciones
Copilot: Obtener registros relacionados
Esta acción obtiene registros relacionados con un registro CRM. La acción mejora las aptitudes existentes de Copilot for Sales.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
recordType | True | string |
Esta entrada identifica el tipo de registro en CRM para el que se solicitan los registros relacionados. |
|
Id. de registro
|
recordId | True | string |
Esta entrada proporciona el identificador único del registro CRM para el que se solicitan los registros relacionados. |
|
Fecha de inicio
|
startDateTime | date-time |
Escriba la fecha y hora de inicio en el formato: 2017-05-02T01:44Z |
|
|
Arriba
|
top | integer |
Esta entrada indica el número de registros relacionados que se van a capturar. |
|
|
Omitir
|
skip | integer |
Esta entrada indica el número de registros que se van a omitir al capturar registros relacionados. |
|
|
Tipo de CRM
|
crmType | string |
Esta entrada indica el tipo de CRM en el que se capturan los registros relacionados. |
|
|
DIRECCIÓN URL de la organización de CRM
|
crmOrgUrl | string |
Esta entrada indica la dirección URL del entorno de CRM desde la que se capturan los registros relacionados. |
Devoluciones
Creación de sobre mediante plantilla
Cree un nuevo sobre mediante una plantilla especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Template
|
templateId | True | string |
ID de plantilla |
|
Estado del sobre
|
status | True | string |
Estado del sobre |
Devoluciones
Creación de sobre mediante plantilla con destinatarios y pestañas
Creación de sobre mediante plantilla con destinatarios y pestañas
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Template
|
templateId | True | string |
Identificador de plantilla |
|
Recipientes
|
recipients | dynamic |
Firmantes del documento. |
|
|
Asunto del correo electrónico
|
emailSubject | string |
Asunto del correo electrónico |
Devoluciones
Creación de sobre mediante plantillas compuestas
Creación de sobre mediante plantillas compuestas
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Asunto del correo electrónico
|
emailSubject | True | string |
Asunto del correo electrónico. |
|
Cuerpo del mensaje
|
emailBody | string |
Cuerpo del correo electrónico. |
|
|
Estado del sobre
|
status | True | string |
Estado del sobre |
|
body
|
body | dynamic |
Devoluciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador de sobre
|
envelopeId | string |
Identificador del sobre. |
|
Estado
|
status | string |
Estado del sobre. |
|
Fecha y hora de estado
|
statusDateTime | string |
Fecha y hora en que se estableció el estado. |
|
URI
|
uri | string |
Identificador URI del sobre en DocuSign. |
Creación de una lista de envío masiva
Creación de una lista de envío masiva
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Nombre de la lista de envío masivo
|
name | True | string |
Nombre de la lista de envío masivo |
|
Archivo CSV
|
csv | string |
Cargar archivo CSV |
Devoluciones
- Body
- BulkSendListGuid
Crear sobre
Cree un nuevo sobre en blanco.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Asunto del correo electrónico
|
emailSubject | True | string |
Asunto del correo electrónico. |
|
Cuerpo del mensaje
|
emailBody | string |
Cuerpo del correo electrónico. |
|
|
Campos personalizados
|
accountCustomFields | dynamic |
Obtenga los campos personalizados establecidos en el nivel de cuenta. |
Devoluciones
EN DESUSO: Agregar destinatario a un sobre
Agregue el destinatario a un sobre.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Nombre del firmante
|
AddRecipientToEnvelopeName | True | string |
Nombre del destinatario. |
|
Correo electrónico del firmante
|
AddRecipientToEnvelopeEmail | True | string |
El correo electrónico del destinatario. |
|
Orden de firma
|
routingOrder | string |
Orden de firma del destinatario en el documento. |
|
|
Rol
|
roleName | string |
Rol del firmante. |
Devoluciones
EN DESUSO: Creación de sobre mediante plantilla
Cree un nuevo sobre mediante una plantilla especificada.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Template
|
templateId | True | string |
ID de plantilla |
|
Estado del sobre
|
status | True | string |
Estado del sobre |
|
Campos personalizados
|
accountCustomFields | True | dynamic |
Obtenga los campos personalizados establecidos en el nivel de cuenta. |
Devoluciones
EN DESUSO: Creación de sobre mediante plantilla con destinatarios
Cree un nuevo sobre mediante una plantilla especificada y especifique destinatarios.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Estado del sobre
|
status | True | string |
Estado del sobre |
|
Template
|
templateId | True | string |
ID de plantilla |
|
Firmantes
|
signers | dynamic |
Firmantes del documento. |
|
|
Asunto del correo electrónico
|
emailSubject | string |
Asunto del correo electrónico |
|
|
Cuerpo del mensaje
|
emailBody | string |
Cuerpo del mensaje |
Devoluciones
EN DESUSO: Obtener documentos del sobre
Obtener documentos del sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Certificado de finalización
|
certificate | True | boolean |
Cuando se establece en false, el certificado de firma de sobre se quita de la descarga. |
Devoluciones
- response
- GetDocumentsResponse
Enumerar destinatarios del sobre
Enumerar destinatarios del sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Carpeta
|
folderId | True | string |
Id. de carpeta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
Devoluciones
Enumerar documentos de un sobre
Enumerar documentos de un sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
Devoluciones
Enumerar documentos de una plantilla
Enumerar documentos de una plantilla
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Template
|
templateId | True | string |
ID de plantilla |
Devoluciones
Envío de sobre
Envíe un sobre existente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
Devoluciones
- response
- object
Generar dirección URL de firma incrustada (V2)
Generar dirección URL de firma incrustada (V2)
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Id. de sobre |
|
¿Es un firmante en persona?
|
isInPersonSigner | True | string |
Sí/No |
|
Método de autenticación
|
authenticationMethod | True | string |
Método de autenticación |
|
Dirección URL de devolución
|
returnUrl | True | string |
Dirección URL de devolución |
|
Dirección URL agregada adicional
|
additionalURL | True | dynamic |
Dirección URL agregada adicional. |
Devoluciones
Generar dirección URL de firma incrustada [EN DESUSO]
Generar dirección URL de firma insertada
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Id. de sobre |
|
Nombre del firmante
|
signerName | True | string |
Nombre del firmante |
|
Correo electrónico del firmante
|
signerEmail | True | string |
Correo electrónico del firmante |
|
Id. de usuario de cliente
|
clientUserId | string |
Necesario a menos que el firmante esté en persona. Deje en blanco para los firmantes en persona |
|
|
Método de autenticación
|
authenticationMethod | True | string |
Método de autenticación |
|
Dirección URL de devolución
|
returnUrl | True | string |
Dirección URL de devolución |
|
Dirección URL agregada adicional
|
additionalURL | dynamic |
Dirección URL agregada adicional. |
Devoluciones
Generar dirección URL del remitente incrustado
Generar dirección URL del remitente incrustado
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Abrir en
|
openIn | True | string |
Abrir en |
|
Dirección URL de devolución
|
returnUrl | True | string |
Dirección URL de devolución |
|
Dirección URL agregada adicional
|
additionalURL | dynamic |
Dirección URL agregada adicional. |
Devoluciones
Iniciar sesión
Inicio del flujo de trabajo de Docusign Maestro
Inicio del flujo de trabajo de Docusign Maestro
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
flujo de trabajo
|
workflowId | True | string |
Escriba el identificador de flujo de trabajo o seleccione el nombre del flujo de trabajo en la lista desplegable. |
|
nombre de instancia
|
instanceName | True | string |
Nombre de la instancia de flujo de trabajo maestro |
|
variable
|
variable | dynamic |
Devoluciones
TriggerMaestroFlowResponse
- response
- object
Mostrar número de compilación (solo para referencia). No incluya en un flujo para su ejecución).
Identificador de la compilación implementada actualmente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Número de compilación
|
buildNumber | dynamic |
Devoluciones
- response
- object
Obtención de campos de formulario de generación de documentos a partir del sobre
Obtención de campos de formulario de generación de documentos a partir del sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
Devoluciones
Obtención de campos personalizados de documentos a partir del sobre
Obtención de campos personalizados de documentos a partir del sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Id. de documento
|
documentId | True | string |
Id. de documento |
Devoluciones
Obtención de información de campo personalizada del sobre
Obtención de información de campo personalizada del sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Nombre de campo personalizado
|
fieldName | True | string |
Nombre de campo personalizado |
Devoluciones
Obtención de información del destinatario del sobre
Obtención de información del destinatario del sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Correo electrónico del destinatario
|
recipientEmail | string |
Correo electrónico del destinatario |
|
|
Código de área
|
areaCode | string |
Código de área del destinatario |
|
|
Número de teléfono
|
phoneNumber | string |
Número de teléfono del destinatario |
|
|
Id. de destinatario
|
recipientId | string |
Identificador de Recipinet |
Devoluciones
- Body
- Signer
Obtención de pestañas de destinatarios del sobre
Obtención de pestañas de destinatarios del sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Id. de destinatario
|
recipientId | True | string |
Id. de destinatario |
Devoluciones
Obtención de pestañas de documento de la plantilla
Obtención de pestañas de documento de la plantilla
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Template
|
templateId | True | string |
ID de plantilla |
|
Id. de documento
|
documentId | True | string |
Id. de documento |
Devoluciones
- Body
- ListTabsResponse
Obtener documentos de un sobre
Obtener documentos de un sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Formato de salida
|
documentId | True | string |
Proporcione un identificador de documento específico o use un formato de salida en la lista desplegable. |
Devoluciones
- response
- GetDocumentsResponse
Obtener información del documento del sobre
Obtener información del documento del sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Nombre del documento
|
documentName | True | string |
Nombre de archivo con extensión |
Devoluciones
- Body
- EnvelopeDocument
Obtener información para la pestaña destinatario
Devuelve el valor de la pestaña para el destinatario especificado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Id. de destinatario
|
recipientId | True | string |
Id. de destinatario |
|
Etiqueta de tabulación
|
tabLabel | True | string |
Etiqueta de tabulación |
Devoluciones
- Body
- Tab
Obtener la lista de eventos de auditoría
Obtener la lista de eventos de auditoría
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
Devoluciones
- response
- object
Obtener pestañas de documento del sobre
Obtener pestañas de documento del sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Id. de documento
|
documentId | True | string |
Id. de documento |
Devoluciones
- Body
- ListTabsResponse
Plantillas de lista
Enumerar plantillas para una cuenta específica.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
Devoluciones
Quitar destinatario de un sobre
Quitar destinatario de un sobre
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Carpeta
|
folderId | True | string |
Id. de carpeta |
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
|
Destinatario
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
Id. de destinatario |
Devoluciones
Reenviar el sobre
Esta acción reenvía un sobre docusign o envía un aviso a los destinatarios que necesitan firmar un acuerdo de Docusign basado en un EnvelopeId proporcionado.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Sobre
|
envelopeId | True | string |
Identificador de sobre |
Devoluciones
- response
- object
Sobre de envío masivo mediante plantilla
Sobre de envío masivo mediante plantilla
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
GUID de lista de envío masivo
|
bulkSendListId | True | string |
GUID de lista de envío masivo |
|
Identificador de plantilla
|
envelopeOrTemplateId | True | string |
Escriba el identificador de plantilla o elija una plantilla en la lista desplegable. |
Devoluciones
- Body
- BulkSendListGuid
Sobres de lista
Esta acción devuelve los sobres de Docusign pertinentes en función del estado del sobre, el intervalo de fechas, el nombre del destinatario, la dirección de correo electrónico del destinatario, el título del sobre, el nombre del documento o el valor de campo personalizado del sobre. La salida es el título, la descripción, el identificador de sobre, los nombres de documento, los nombres de remitente, el estado del sobre, la fecha de estado, la fecha enviada y una dirección URL del sobre que se puede usar como vínculo para ver el sobre en Docusign.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Nombre del destinatario
|
recipientName | string |
Esta acción enumera los sobres basados en el nombre del destinatario. |
|
|
Correo electrónico del destinatario
|
recipientEmailId | string |
Filtra los sobres por correo electrónico del destinatario |
|
|
Asunto del sobre
|
envelopeTitle | string |
Filtra los sobres por asunto del sobre |
|
|
Nombre de campo personalizado
|
customFieldName | string |
Esta acción enumera los sobres basados en un nombre de sus campos personalizados. |
|
|
Valor de campo personalizado
|
customFieldValue | string |
Filtra por valor de campo personalizado |
|
|
Estado del sobre
|
envelopeStatus | string |
Esta acción enumera sobres en función del estado del sobre |
|
|
Carpeta
|
folder_ids | string |
Filtra los sobres por la carpeta seleccionada. |
|
|
Ordenar por
|
order_by | string |
Ordena los sobres en el orden seleccionado. |
|
|
Devolver sobres
|
top | integer |
Especifique el número de sobres que se van a devolver (el valor predeterminado es 10; el máximo es 1000) |
|
|
Omitir sobres
|
skip | integer |
Especifique el número de sobres que se omitirá desde el principio. |
|
|
Fecha de inicio
|
from_date | date-time |
Escriba la fecha y hora de inicio en formato UTC: 2017-05-02T01:44z |
|
|
Fecha de finalización
|
to_date | date-time |
Escriba la fecha y hora de finalización en formato UTC: 2017-05-02T01:44z. |
Devoluciones
Desencadenadores
| Cuando cambia un estado de sobre (Connect) (V3) |
Desencadena un nuevo flujo cuando cambia un estado de sobre. |
| EN DESUSO: cuando cambia un estado de sobre (Conectar) |
Desencadena un nuevo flujo cuando cambia un estado de sobre. |
| EN DESUSO: cuando cambia un estado de sobre (Connect) (V2) |
Desencadena un nuevo flujo cuando cambia un estado de sobre. |
Cuando cambia un estado de sobre (Connect) (V3)
Desencadena un nuevo flujo cuando cambia un estado de sobre.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Nombre de conexión
|
name | True | string | |
|
Evento Envelope
|
envelopeEvents | True | string |
Devoluciones
EN DESUSO: cuando cambia un estado de sobre (Conectar)
Desencadena un nuevo flujo cuando cambia un estado de sobre.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Nombre de conexión
|
name | True | string | |
|
Evento Envelope
|
envelopeEvents | True | string |
Devoluciones
EN DESUSO: cuando cambia un estado de sobre (Connect) (V2)
Desencadena un nuevo flujo cuando cambia un estado de sobre.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Cuenta
|
accountId | True | string |
Id. de cuenta |
|
Nombre de conexión
|
name | True | string | |
|
Evento Envelope
|
envelopeEvents | True | string |
Devoluciones
Definiciones
WebhookEnvelopeResponseV2
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Campos personalizados
|
data.envelopeSummary.customFields | object |
Pares clave-valor que representan los campos personalizados para este sobre (donde key es el nombre del campo y el valor es el valor del campo). |
|
Date-Time sobre creado
|
data.envelopeSummary.createdDateTime | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
Id. de sobre
|
data.envelopeSummary.envelopeId | string | |
|
Sobre enviado Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
Estado del sobre
|
data.envelopeSummary.status | string | |
|
Asunto del correo electrónico
|
data.envelopeSummary.emailSubject | string | |
|
Nombre del remitente
|
data.envelopeSummary.sender.userName | string | |
|
Id. de usuario del remitente
|
data.envelopeSummary.sender.userId | string | |
|
Id. de cuenta del remitente
|
data.envelopeSummary.sender.accountId | string | |
|
Dirección de correo electrónico del remitente
|
data.envelopeSummary.sender.email | string | |
|
Firmantes
|
data.envelopeSummary.recipients.signers | array of object | |
|
Pestañas
|
data.envelopeSummary.recipients.signers.tabs | object |
Pares clave-valor que representan las pestañas de este destinatario (donde key es el nombre del campo y el valor es el valor del campo). |
|
Correo electrónico del destinatario
|
data.envelopeSummary.recipients.signers.email | string | |
|
Id. de destinatario
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Orden de enrutamiento
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Date-Time enviados por el destinatario
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
Estado del destinatario
|
data.envelopeSummary.recipients.signers.status | string |
Estado del destinatario. |
|
Tipo de destinatario
|
data.envelopeSummary.recipients.signers.recipientType | string |
Tipo de destinatario. |
|
Tipo de verificación
|
data.envelopeSummary.recipients.signers.verificationType | string |
Tipo de la comprobación. |
|
Nombre del destinatario
|
data.envelopeSummary.recipients.signers.name | string |
Nombre del destinatario. |
WebhookEnvelopeResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Campos personalizados
|
customFields | object |
Pares clave-valor que representan los campos personalizados para este sobre (donde key es el nombre del campo y el valor es el valor del campo). |
|
Date-Time sobre creado
|
DocuSignEnvelopeInformation.EnvelopeStatus.Created | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
Dirección de correo electrónico del remitente
|
DocuSignEnvelopeInformation.EnvelopeStatus.Email | string | |
|
Id. de sobre
|
DocuSignEnvelopeInformation.EnvelopeStatus.EnvelopeID | string | |
|
Dirección IP del remitente
|
DocuSignEnvelopeInformation.EnvelopeStatus.SenderIPAddress | string | |
|
Sobre enviado Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Sent | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
Estado del sobre
|
DocuSignEnvelopeInformation.EnvelopeStatus.Status | string | |
|
Asunto
|
DocuSignEnvelopeInformation.EnvelopeStatus.Subject | string | |
|
Nombre del remitente
|
DocuSignEnvelopeInformation.EnvelopeStatus.UserName | string | |
|
RecipientStatus
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus | array of object | |
|
Pestañas
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.tabs | object |
Pares clave-valor que representan las pestañas de este destinatario (donde key es el nombre del campo y el valor es el valor del campo). |
|
Motivo del rechazo
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.DeclineReason | DeclineReasonWithoutType | |
|
Correo electrónico del destinatario
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Email | string | |
|
Id. de destinatario
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RecipientId | string | |
|
Orden de enrutamiento
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RoutingOrder | string | |
|
Date-Time enviados por el destinatario
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Sent | date-time |
aaaa-MM-ddTHH:mm:ss.fffZ |
|
Estado del destinatario
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Status | string |
Estado del destinatario. |
|
Tipo de destinatario
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Type | string |
Tipo de destinatario. |
|
Nombre del destinatario
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.UserName | string |
Nombre del destinatario. |
|
Zona horaria
|
DocuSignEnvelopeInformation.TimeZone | string | |
|
Desplazamiento de zona horaria
|
DocuSignEnvelopeInformation.TimeZoneOffset | string |
GetDocumentsResponse
- Contenido del archivo
- binary
AddRemindersResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Aviso habilitado
|
reminderEnabled | string |
Aviso habilitado |
FilteredEnvelopes
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Title
|
title | string |
Título del sobre |
|
Description
|
description | string |
Descripción de la actividad de sobre |
|
Id. de sobre
|
envelopeId | string |
Id. de sobre |
|
Documentos
|
documents | string |
Lista de nombres de documento |
|
Nombres de destinatarios
|
recipients | string |
Lista de nombres de destinatarios |
|
Nombre del remitente
|
sender | string |
Nombre del remitente |
|
Estado
|
status | string |
Estado del sobre |
|
Fecha de estado
|
statusDate | string |
Última actualización de estado de la actividad |
|
Fecha de envío
|
dateSent | date-time |
Fecha de envío del sobre |
|
URL
|
url | string |
Dirección URL del sobre |
SalesCopilotFilteredEnvelopes
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Title
|
title | string |
Título del sobre |
|
Subtítulo
|
subTitle | string |
Subtitle del sobre |
|
URL
|
url | string |
Dirección URL del sobre |
|
Propiedades adicionales
|
additionalPropertiesForSalesEnvelope.additionalPropertiesForSalesEnvelope | string |
Propiedades adicionales |
Activity
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Title
|
title | string |
Esta salida indica el título de la actividad en la tarjeta de cita. |
|
Description
|
description | string |
Esta salida indica la descripción de la información. |
|
DateTime
|
dateTime | date-time |
Este resultado indica el tiempo asociado al análisis. |
|
URL
|
url | string |
Esta salida indica la dirección URL para abrir la información. |
|
Propiedades adicionales
|
additionalProperties.additionalProperties | string |
Propiedades adicionales de la actividad |
EmailSummary
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Title
|
Title | string |
Esta salida indica el título de la sección del asociado y debe incluir solo el nombre del asociado. |
|
descripción
|
Description | string |
Este resultado indica el texto que le gustaría que se incluyera en el resumen del correo electrónico. |
KeySales
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Title
|
Title | string |
Esta salida indica el título de la tarjeta de referencia para el análisis. |
|
descripción
|
description | string |
Este resultado refleja el texto de la perspectiva que se va a incluir en los informes de ventas clave. |
|
Dirección URL del sobre
|
url | string |
Esta salida indica la dirección URL para obtener más información sobre el análisis. |
|
Tiempo asociado a la información
|
dateTime | string |
Este resultado indica el tiempo asociado al análisis. |
|
Propiedades adicionales
|
additionalProperties.additionalProperties | string |
Esta salida indica propiedades adicionales en forma de pares de nombre y valor de cada perspectiva relacionada devuelta por la acción. |
DocumentRecord
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de registro
|
recordId | string |
Esta salida identifica de forma única cada registro relacionado devuelto por la acción. |
|
Nombre para mostrar del tipo de registro
|
recordTypeDisplayName | string |
Esta salida indica el nombre para mostrar del tipo de registro de cada registro relacionado devuelto por la acción. |
|
Nombre para mostrar del tipo de registro en plural
|
recordTypePluralDisplayName | string |
Esta salida indica el nombre para mostrar plural del tipo de registro de cada registro relacionado devuelto por la acción. |
|
Tipo de registro
|
recordType | string |
Esta salida indica el tipo de cada registro relacionado devuelto por la acción. |
|
Título del registro
|
recordTitle | string |
Esta salida indica el título de cada registro relacionado devuelto por la acción. |
|
Dirección URL del sobre
|
url | string |
Esta salida indica la dirección URL de cada registro relacionado devuelto por la acción. |
|
Propiedades adicionales
|
additionalProperties.additionalProperties | string |
Esta salida indica propiedades adicionales como pares nombre-valor de cada registro relacionado devuelto por la acción. |
EmbeddedSenderResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Dirección URL del remitente incrustado
|
url | string |
Dirección URL de la vista remitente incrustada. |
EmbeddedSigningResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
URL
|
url | string |
Dirección URL de la vista de firma incrustada. |
FilteredEnvelopeListResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Sobres filtrados
|
value | array of FilteredEnvelopes |
Sobres filtrados |
|
Más resultados de sobre
|
hasMoreResults | boolean |
Muestra si los sobres superan el número especificado en el campo Sobres devueltos |
FilteredSalesCopilotEnvelopeListResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Sobres filtrados
|
value | array of SalesCopilotFilteredEnvelopes |
Sobres filtrados |
|
tieneMásResultados
|
hasMoreResults | boolean |
ActivityListResponseEnvelope
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Actividades relacionadas
|
value | array of Activity |
Actividades relacionadas |
|
tieneMásResultados
|
hasMoreResults | boolean |
EmailSummaryResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Resumen del correo electrónico
|
value | array of EmailSummary |
Ventas de claves |
|
tieneMásResultados
|
hasMoreResults | boolean |
KeySalesResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Ventas clave'
|
value | array of KeySales |
Ventas de claves |
|
tieneMásResultados
|
hasMoreResults | boolean |
DocumentRecordListResponseEnvelope
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Registros relacionados
|
value | array of DocumentRecord |
Registros relacionados |
|
tieneMásResultados
|
hasMoreResults | boolean |
CreateEnvelopeResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador de sobre
|
envelopeId | string |
Identificador del sobre. |
|
ID de plantilla
|
templateId | string |
Identificador de la plantilla. |
|
Estado
|
status | string |
Estado del sobre. |
|
Fecha y hora de estado
|
statusDateTime | string |
Fecha y hora en que se estableció el estado. |
|
URI
|
uri | string |
Identificador URI del sobre en DocuSign. |
ListRecipientsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Firmantes
|
signers | array of Signer |
Firmantes |
Pestaña
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre de la pestaña
|
name | string |
Nombre de la pestaña. |
|
Tipo de pestaña
|
tabType | string |
Tipo de la pestaña. |
|
Etiqueta de pestaña
|
tabLabel | string |
Etiqueta de la pestaña. |
|
Valor de tabulación
|
value | string |
Valor de la pestaña. |
|
Identificador de pestaña
|
tabId | string |
Identificador de la pestaña. |
|
Id. de documento
|
documentId | string |
Identificador del documento. |
|
Id. de destinatario
|
recipientId | string |
Identificador del destinatario. |
|
Es Prerrellenar
|
prefill | boolean |
Indica si la pestaña es de tipo de prerrellenar. |
|
Selected
|
selected | string |
Si las pestañas están activadas, indica si la pestaña está seleccionada. |
RecipientTabsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Pestaña Destinatario:
|
recipientTabs | array of Tab |
Pestaña Destinatario |
Firmante
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Orden de firma
|
routingOrder | string |
Orden de firma del destinatario en el documento. |
|
Rol
|
roleName | string |
Rol del firmante. |
|
Id. de destinatario
|
recipientId | string |
Identificador del destinatario. |
|
Nombre
|
name | string |
Nombre del destinatario. |
|
Correo Electrónico
|
string |
El correo electrónico del destinatario. |
|
|
Tipo de destinatario
|
recipientType | string |
Escriba el destinatario. |
|
Tipo de verificación
|
verificationType | string |
Tipo de comprobación. |
|
Guid del destinatario
|
recipientIdGuid | string |
Guid del destinatario. |
GetLoginAccountsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Cuentas de inicio de sesión
|
loginAccounts | array of LoginAccount |
Cuentas de inicio de sesión |
LoginAccount
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre
|
name | string |
Nombre de la cuenta. |
|
Guid del identificador de cuenta
|
accountIdGuid | string |
Guid de la cuenta. |
ListTabsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Pestañas
|
tabs | array of Tab |
Pestañas |
ListEnvelopeDocumentFieldsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Campo personalizado
|
envelopeDocumentFields | array of EnvelopeDocumentField |
Campos personalizados de documento |
DocGenFormFieldsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Campos de Docgen
|
docgenFields | array of DocGenFormField |
Campos de Docgen |
DocGenFormField
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de documento
|
documentId | string |
Id. del documento. |
|
Etiqueta
|
label | string |
Etiqueta. |
|
Tipo
|
type | string |
Tipo. |
|
Nombre
|
name | string |
Nombre. |
|
Importancia
|
value | string |
Valor. |
ListTemplatesResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Plantillas de sobre
|
envelopeTemplates | array of EnvelopeTemplate |
Las plantillas de sobre disponibles. |
EnvelopeTemplate
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
ID de plantilla
|
templateId | string |
Identificador de la plantilla. |
|
Nombre
|
name | string |
El nombre de la plantilla. |
BulkSendListGuid
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Guid de lista de envío masivo
|
listId | string |
Guid de lista de envío masivo |
EnvelopeCustomFieldResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de campo
|
fieldId | string |
Identificador del campo personalizado de sobre. |
|
Tipo de campo
|
fieldType | string |
Tipo del campo personalizado de sobre. |
|
Nombre
|
name | string |
Nombre del campo personalizado de sobre. |
|
Importancia
|
value | string |
Valor del campo personalizado de sobre. |
UpdateEnvelopeCustomFieldResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. de campo
|
fieldId | string |
Identificador del campo personalizado de sobre. |
|
Tipo de campo
|
fieldType | string |
Tipo del campo personalizado de sobre. |
|
Nombre
|
name | string |
Nombre del campo personalizado de sobre. |
|
Importancia
|
value | string |
Valor del campo personalizado de sobre. |
ListDocumentsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Documentos sobre
|
envelopeDocuments | array of EnvelopeDocument |
Documentos adjuntos al sobre. |
ListTemplateDocumentsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Documentos de plantilla
|
templateDocuments | array of EnvelopeDocument |
Documentos adjuntos a una plantilla. |
AddDocumentsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador de sobre
|
envelopeId | string |
Identificador del sobre. |
|
Documentos sobre
|
envelopeDocuments | array of EnvelopeDocument |
Documentos adjuntos al sobre. |
AddRecipientTabsResponse
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Pestañas de destinatarios
|
recipientTabs | array of RecipientTab |
Pestañas agregadas a un destinatario. |
EnvelopeDocument
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre
|
name | string |
Nombre del documento. |
|
Id. de documento
|
documentId | string |
Identificador del documento. |
|
Guid de documento
|
documentIdGuid | string |
Guid del documento. |
RecipientTab
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador de pestaña
|
tabId | string |
Identificador de la pestaña. |
|
Tipo de pestaña
|
tabType | string |
Tipo de la pestaña. |
EnvelopeDocumentField
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Nombre
|
name | string |
Nombre del campo personalizado. |
|
Importancia
|
value | string |
Valor del campo personalizado. |
DeclineReasonWithoutType
objeto
Este es el tipo 'object'.