Introducción
El conector de Pipedrive de Bizagi está disponible en el Connectors Xchange de Bizagi.
A través de este conector, podrá conectar sus procesos de Bizagi a una cuenta de Pipedrive y usar sus servicios.
Para más información de las capacidades de este conector, visite nuestro Connectors Xchange.
|
Este Conector se desarrolló de acuerdo con los contenidos del API o información sobre los mismos suministrada por Pipedrive. Bizagi no se hace responsable por errores derivados del llamado de los servicios del API, incongruencias en la documentación presentada por Pipedrive. Ni Bizagi ni sus filiales serán responsables de ofrecer cualquier tipo de garantía sobre los contenidos o errores derivados del llamado de los servicios del API. Bizagi y sus filiales no se harán responsables de las pérdidas, los costos o los daños en los que se incurra como consecuencia del acceso o el uso de los servicios del API de Pipedrive.
Este conector se encuentra actualmente en versión Beta. Úselo en ambientes de producción bajo su propio riesgo. |
Antes de iniciar
Para probar y usar este conector, necesita:
1.Bizagi Studio previamente instalado.
2.El conector previamente instalado, tal como se describe en https://help.bizagi.com/platform/es/index.html?Connectors_Xchange.htm, o a través del manual de instalación descrito en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm.
3.Un Sandbox y una API key para su Pipedrive.
Obtener su Sandbox y API key de Pipedrive
Siga estos pasos para crear su dominio.
1.Diríjase a https://pipedrive.readme.io/docs/developer-sandbox-account.
2.En el segundo párrafo haga click en el enlace que dice webform.
3.Llene los campos necesarios de la forma interactiva.
4.Pipedrive deberá aprobar y crear su dominio en la siguientes 24-48 horas.
Configurar el conector
Para configurar el conector siga los pasos descritos en el capítulo de configuración en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm.
Tenga en cuenta los siguientes parámetros de autenticación:
•Authentication method: Custom
•DOMAIN: Dominio asignado a su Pipedrive.
•API_KEY: API key que se le asigno al dominio.
Usar el conector
Éste conector permite el uso desde Bizagi de varios métodos disponibles para el uso de los servicios de Pipedrive.
Para configurar el conector, por favor visite el artículo https://help.bizagi.com/platform/es/index.html?Connectors_Studio.htm.
Al usar el conector, asegúrese de tener en cuenta, para los métodos disponibles, los siguientes detalles:
Add an organization (Agregar una organización )
Esta acción agrega una nueva organización/empresa al sistema.
Para configurar las entradas de esta acción tenga en cuenta:
•name (Requerido): nombre de la organización. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•owner_id: número de id del propietario, si se deja vacío se toma por defecto el usuario autenticado. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•address: dirección de la empresa. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
Update an organization (Actualizar una organización)
Esta acción actualiza una organización/empresa existente del sistema.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la organización. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•name (Requerido): nombre de la organización. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•owner_id: número de id del propietario, si se deja vacío se toma por defecto el usuario autenticado. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•address: dirección de la empresa. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
Delete an organization (Eliminar una organización)
Esta acción elimina una organización/empresa del sistema.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la organización. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
Get details of an organization (Obtener detalles de una organización)
Esta acción obtiene información detallada de una organización/empresa.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la organización. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
Find organizations by name (Buscar organizaciones por nombre)
Esta acción busca organizaciones/empresas usando una palabra clave..
Para configurar las entradas de esta acción tenga en cuenta:
•term (Requerido): palabra clave de la búsqueda. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•start: índice en el cual inician de resultados. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: límite de registros que se van a obtener. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
List persons of an organization (Listar personas of una organización)
Esta acción retorna un listado de personas asociadas a una organización.
Para configurar las entradas de esta acción tenga en cuenta:
•org_id (Requerido): número de id de la organización a consultar. Este parámetro debe ser un número en su modelo de Bizagi.
•start: índice en el cual inician de resultados. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: límite de registros que se van a obtener. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
List deals associated with an organization (Listar acuerdos de una organización)
Esta acción retorna un listado de acuerdos relacionados con una organización/empresa.
Para configurar las entradas de esta acción tenga en cuenta:
•org_id (Requerido): número de id de la organización a consultar. Este parámetro debe ser un número en su modelo de Bizagi.
•start: índice de inicio de resultados. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: límite de registros a consultar. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
List activities associated with an organization (Listar actividades de una organización)
Esta acción retorna un listado de actividades asociadas a una organización/empresa.
Para configurar las entradas de esta acción tenga en cuenta:
•org_id (Requerido): número de id de la organización a consultar. Este parámetro debe ser un número en su modelo de Bizagi.
•start: índice de inicio de resultados. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: límite de registros a consultar. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Organizations.
Add an activity (Agregar una actividad )
Esta acción agrega una nueva actividad en el sistema.
Para configurar las entradas de esta acción tenga en cuenta:
•subject (Requerido): título de la actividad. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•done: si la actividad se ha completado (0 = no terminada, 1 = terminada). Este parámetro debe ser un número en su modelo de Bizagi.
•type (Requerido): tipo de la actividad (llamada = 1, reunion = 2, tarea = 3, entrega = 4, email = 5, almuerzo = 6). Este parámetro debe ser un número en su modelo de Bizagi.
•due_date: fecha de entrega de la actividad (YYYY-MM-DD). Este parámetro debe ser una fecha en su modelo de Bizagi.
•due_time: hora de entrega de la actividad (HH:MM). Este parámetro debe ser de tipo String en su modelo de Bizagi.
•duration: duración de la actividad (HH:MM). Este parámetro debe ser de tipo String en su modelo de Bizagi.
•user_id: número de id del usuario asignado a la actividad. Si se omite, la actividad queda asignada al usuario autenticado. Este parámetro debe ser de tipo double en su modelo de Bizagi.
•deal_id: número de id del acuerdo asociado a la actividad. Este parámetro debe ser un número en su modelo de Bizagi.
•person_id: número de id de la persona asociada a la actividad. Este parámetro debe ser un número en su modelo de Bizagi.
•org_id: número de id de la organización que ejecuta la actividad. Este parámetro debe ser un número en su modelo de Bizagi.
•note: notas adicionales. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Activities.
Edit an activity (Actualizar una actividad)
Esta acción actualiza una actividad existente en el sistema.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la actividad. Este parámetro debe ser un número en su modelo de Bizagi.
•subject (Requerido): título de la actividad. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•done: si la actividad se ha completado (0 = no terminada, 1 = terminada). Este parámetro debe ser un número en su modelo de Bizagi.
•type (Requerido): tipo de la actividad (llamada = 1, reunion = 2, tarea = 3, entrega = 4, email = 5, almuerzo = 6). Este parámetro debe ser un número en su modelo de Bizagi.
•due_date: fecha de entrega de la actividad (YYYY-MM-DD). Este parámetro debe ser una fecha en su modelo de Bizagi.
•due_time: hora de entrega de la actividad (HH:MM). Este parámetro debe ser de tipo String en su modelo de Bizagi.
•duration: duración de la actividad (HH:MM). Este parámetro debe ser de tipo String en su modelo de Bizagi.
•user_id: número de id del usuario asignado a la actividad. Si se omite, la actividad queda asignada al usuario autenticado. Este parámetro debe ser de tipo double en su modelo de Bizagi.
•deal_id: número de id del acuerdo asociado a la actividad. Este parámetro debe ser un número en su modelo de Bizagi.
•person_id: número de id de la persona asociada a la actividad. Este parámetro debe ser un número en su modelo de Bizagi.
•org_id: número de id de la organización que ejecuta la actividad. Este parámetro debe ser un número en su modelo de Bizagi.
•note: notas adicionales. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Activities.
Delete an activity (Eliminar una actividad)
Esta acción elimina una actividad.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la actividad. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Activities.
Get details of an activity (Obtener detailles de una actividad)
Esta acción obtiene información detallada de una actvidad.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la actividad. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Activities.
Get all activities assigned to a particular user (Obtener todas las actividades asignadas a un usuario)
Esta acción obtiene un listado de actividades asociadas a un usuario en particular.
Para configurar las entradas de esta acción tenga en cuenta:
•user_id: número de id del usuario. Si se omite, se usará el usuario autenticado. Si es 0, se buscarán actividades para todos los usuarios en la empresa.. Este parámetro debe ser de tipo double en su modelo de Bizagi.
•type: tipo de la actividad (llamada = 1, reunion = 2, tarea = 3, entrega = 4, email = 5, almuerzo = 6). Este parámetro debe ser un número en su modelo de Bizagi.
•start: índice donde iniciara la busqueda. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: Items a mostrar por página. Este parámetro debe ser un número en su modelo de Bizagi.
•start_date: Fecha de inicio de la busqueda en formato de YYYY-MM-DD. Este parámetro debe ser una fecha en su modelo de Bizagi.
•end_date: Fecha limite de la búsqueda en formato YYYY-MM-DD. Este parámetro debe ser una fecha en su modelo de Bizagi.
•done: Si la actividad se ha completado o no. 0 = Sin terminar, 1 = Terminada. . Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Activities.
Add a Deal (Agregar un acuerdo)
Esta acción agrega un nuevo acuerdo.
Para configurar las entradas de esta acción tenga en cuenta:
•title (Requerido): título del acuerdo. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•value: valor monetario del acuerdo, si se omite se usa como valor por defecto 0. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•currency: divisa. Acepta un código de moneda de 3 caracteres (USD, GBP, JPY). Si se omite, se usara la divisa predeterminada del usuario autenticado.. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•user_id: número de id del usuario que va a ser marcado como propietario del acuerdo. Este parámetro debe ser de tipo double en su modelo de Bizagi.
•person_id: número de id de la persona con la que va a ser asociado con el acuerdo. Este parámetro debe ser un número en su modelo de Bizagi.
•org_id: número de id de la organización. Este parámetro debe ser un número en su modelo de Bizagi.
•stage_id: número de id de la etapa en la que se cerrará este acuerdo (tenga en cuenta que no puede proporcionar la número de id del pipeline, ya que se asignará automáticamente en función de stage_id). Si se omite, el acuerdo se colocará en la primera stage del pipeline predeterminada.. Este parámetro debe ser un número en su modelo de Bizagi.
•status: Estado del acuerdo. Solo acepta estas opciones abierto = Open, ganado = Won, perdido = Lost, borrado = Deleted.. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•probability: probabilidad de exito del acuerdo (porcentaje). Este parámetro debe ser de tipo String en su modelo de Bizagi.
•lost_reason: mensaje opcional sobre por qué se perdió el acuerdo (para ser utilizado cuando el estado es perdido). Este parámetro debe ser de tipo String en su modelo de Bizagi.
•add_time: fecha de creación (requiere un API key de tipo admin). Este parámetro debe ser una fecha en su modelo de Bizagi.
•visible_to: visibilidad del acuerdo(1, dueños y seguidores - privado) y (3, toda la compañia - compartido)
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Deals.
Update a Deal (Actualizar un acuerdo)
Esta acción actualiza la información de un acuerdo.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): título del acuerdo. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•title (Requerido): valor monetario del acuerdo, si se omite se usa como valor por defecto 0. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•value: divisa. Acepta un código de moneda de 3 caracteres (USD, GBP, JPY). Si se omite, se usara la divisa predeterminada del usuario autenticado.. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•currency: número de id del usuario que va a ser marcado como propietario del acuerdo. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•user_id: número de id de la persona con la que va a ser asociado con el acuerdo. Este parámetro debe ser de tipo double en su modelo de Bizagi.
•person_id: número de id de la organización. Este parámetro debe ser un número en su modelo de Bizagi.
•org_id: número de id de la etapa en la que se cerrará este acuerdo (tenga en cuenta que no puede proporcionar la número de id del pipeline, ya que se asignará automáticamente en función de stage_id). Si se omite, el acuerdo se colocará en la primera stage del pipeline predeterminada.. Este parámetro debe ser un número en su modelo de Bizagi.
•stage_id: Estado del acuerdo. Solo acepta estas opciones abierto = Open, ganado = Won, perdido = Lost, borrado = Deleted.. Este parámetro debe ser un número en su modelo de Bizagi.
•status: probabilidad de exito del acuerdo (porcentaje). Si se configura el pipeline para que se requiera esta propiedad este campo es requerido. . Este parámetro debe ser de tipo String en su modelo de Bizagi.
•probability: mensaje opcional sobre por qué se perdió el acuerdo (para ser utilizado cuando el estado es perdido). Este parámetro debe ser de tipo String en su modelo de Bizagi.
•lost_reason: fecha de creación (requiere un API key de tipo admin). Este parámetro debe ser de tipo String en su modelo de Bizagi.
•add_time: . Este parámetro debe ser una fecha en su modelo de Bizagi.
•visible_to:
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Deals.
Delete a Deal (Eliminar un acuerdo)
Esta acción elimina un acuerdo del sistema.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id del acuerdo. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Deals.
Get all deals (Obtener todos los acuerdos)
Esta acción obtiene un listado de acuerdos.
Para configurar las entradas de esta acción tenga en cuenta:
•user_id: filtra los acuerdos asignados a este usuario. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•stage_id: filtra los acuerdos con esta etapa. Este parámetro debe ser un número en su modelo de Bizagi.
•status: filtra los acuerdos con este estado. Si se omite, se obtienen todos los acuerdos que no se han eliminado.. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•start: índice donde iniciara la busqueda. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: Items a mostrar por página. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Deals.
Find deals by name (Buscar acuerdos por nombre)
Esta acción obtiene un listado de acuerdos que contienen un nombre.
Para configurar las entradas de esta acción tenga en cuenta:
•term (Requerido): termino o palabra clave de la búsqueda. Este termino debe aparecer en el titulo del acuerdo. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Deals.
Get details of a deal (Obtener detalles de un acuerdo)
Esta acción obtiene infromación detallada de un acuerdo.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id del acuerdo. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Deals.
List participants associated with a deal (Listar los participantes de un acuerdo)
Esta acción obtiene los participantes de un acuerdo.
Para configurar las entradas de esta acción tenga en cuenta:
•id: número de id del acuerdo. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•start: índice donde iniciara la busqueda. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: Items a mostrar por página. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Deals.
Add a person (Agregar una persona)
Esta acción agrega una nueva persona.
Para configurar las entradas de esta acción tenga en cuenta:
•name (Requerido): nombre de la persona. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•org_id: número de id de la organización a la que pertenece la persona. Este parámetro debe ser un número en su modelo de Bizagi.
•email: email de la persona. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•phone: teléfono de la persona. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Persons.
Delete a person (Eliminar una persona)
Esta acción borra una persona del sistema.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la persona. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Persons.
Update a person (Actualizar una persona)
Esta acción actualiza la información de una persona.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la persona. Este parámetro debe ser un número en su modelo de Bizagi.
•name: nombre de la persona. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•org_id: número de id de la organización a la que pertenece la persona. Este parámetro debe ser un número en su modelo de Bizagi.
•email: email de la persona. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•phone: teléfono de la persona. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Persons.
Get all persons (Obtener todas las personas)
Esta acción obtiene un listado de personas permitiendo filtrar por la primera letra de su nombre.
Para configurar las entradas de esta acción tenga en cuenta:
•first_char: si se suministra, solo se devolverán las personas cuyo nombre comience con la letra especificada (no diferencia entre mayúsculas y minúsculas).. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•start: índice donde iniciara la busqueda. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: Items a mostrar por página. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Persons.
Get details of a person (Obtener detalles de una persona)
Esta acción obtiene información detallada de una persona .
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la persona. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Persons.
Find persons by name (Buscar personas por nombre)
Esta acción retorna un listado de personas filtradas por una palabra clave.
Para configurar las entradas de esta acción tenga en cuenta:
•term (Requerido): palabra clave, término de la búsqueda. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•org_id: número de id de la organización/empresa. Este parámetro debe ser un número en su modelo de Bizagi.
•start: índice donde iniciara la busqueda. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: Items a mostrar por página. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Persons.
Add a note (Agregar una nota)
Esta acción agrega una nota a una persona/acuerdo/organización.
Para configurar las entradas de esta acción tenga en cuenta:
•content (Requerido):: contenido de la nota. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•deal_id: número de id del acuerdo al que se va a asociar la nota. Este parámetro debe ser un número en su modelo de Bizagi.
•person_id: número de id de la persona a la que se va a asociar la nota. Este parámetro debe ser un número en su modelo de Bizagi.
•org_id: número de id de la organización a la que se va a asociar la nota. Este parámetro debe ser un número en su modelo de Bizagi.
•pinned_to_deal_flag: indica si esta nota se debe ser marcar como importante en el acuerdo. Este parámetro debe ser un número en su modelo de Bizagi.
•pinned_to_organization_flag: indica si esta nota se debe ser marcar como importante en la organización. Este parámetro debe ser un número en su modelo de Bizagi.
•pinned_to_person_flag: indica si esta nota se debe ser marcar como importante en la persona. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Notes.
Update a note (Actualizar una nota)
Esta acción actualiza una nota existente.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la nota a actualizar. Este parámetro debe ser un número en su modelo de Bizagi.
•content (Requerido):: contenido de la nota. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•deal_id: número de id del acuerdo al que se va a asociar la nota. Este parámetro debe ser un número en su modelo de Bizagi.
•person_id: número de id de la persona a la que se va a asociar la nota. Este parámetro debe ser un número en su modelo de Bizagi.
•org_id: número de id de la organización a la que se va a asociar la nota. Este parámetro debe ser un número en su modelo de Bizagi.
•pinned_to_deal_flag: indica si esta nota se debe ser marcar como importante en el acuerdo. Este parámetro debe ser un número en su modelo de Bizagi.
•pinned_to_organization_flag: indica si esta nota se debe ser marcar como importante en la organización. Este parámetro debe ser un número en su modelo de Bizagi.
•pinned_to_person_flag: indica si esta nota se debe ser marcar como importante en la persona. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Notes.
Get one note (Obtener una note)
Esta acción obtiene los detalles de una nota.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la nota. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Notes.
Delete a note (Eliminar una nota)
Esta acción elimina una nota.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la nota. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Notes.
Get all notes (Obtener todas notes)
Esta acción retorna un listado de notas asociadas a una persona/acuerdo/organización.
Para configurar las entradas de esta acción tenga en cuenta:
•user_id: número de id del usuario al que pertenecen las notas, si se omite se traen todas las notas. Este parámetro debe ser un número en su modelo de Bizagi.
•deal_id: número de id del acuerdo al que pertenecen las notas, si se omite se traen todas las notas. Este parámetro debe ser un número en su modelo de Bizagi.
•person_id: número de id de la persona a la que pertenecen las notas, si se omite se traen todas las notas. Este parámetro debe ser un número en su modelo de Bizagi.
•org_id: número de id de la organización a las que pertenecen las notas, si se omite se traen todas las notas. Este parámetro debe ser un número en su modelo de Bizagi.
•start: índice donde iniciara la busqueda. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: Items a mostrar por página. Este parámetro debe ser un número en su modelo de Bizagi.
•start_date: filtro de fechas desde la cual se quieren obtener las notas. Este parámetro debe ser una fecha en su modelo de Bizagi.
•end_date: filtro de fechas hasta la cual se quieren obtener las notas. Este parámetro debe ser una fecha en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Notes.
Add a product (Agregar un producto)
Esta acción agrega una nuevo producto al sistema.
Para configurar las entradas de esta acción tenga en cuenta:
•name (Requerido): nombre del producto. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•code: código del producto. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•unit: unidad en la que se vende el producto. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•tax: porcentaje de impuestos. Este parámetro debe ser un número en su modelo de Bizagi.
•active_flag: indica si va a estar activo o no (1 = activo, 2 = inactivo). Este parámetro debe ser un número en su modelo de Bizagi.
•cost: costo del producto. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•owner_id: número de id del usuario propietario de este producto. Si se omite, se usará el número de id de usuario autenticado.. Este parámetro debe ser un número en su modelo de Bizagi.
•prices: Matriz de objetos, cada uno contiene: moneda (string), precio (número), costo (número, opcional), costo_encabezado (número, opcional). Tenga en cuenta que solo puede haber un precio por producto por moneda. Cuando se omiten los "precios", no se establecerán precios para el producto.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Products.
Update a product (Actualizar un producto)
Esta acción actualiza la información de un producto.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id del producto. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•name (Requerido): nombre del producto. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•code: código del producto. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•unit: unidad en la que se vende el producto. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•tax: porcentaje de impuestos. Este parámetro debe ser un número en su modelo de Bizagi.
•active_flag: indica si va a estar activo o no (1 = activo, 2 = inactivo). Este parámetro debe ser un número en su modelo de Bizagi.
•cost: costo del producto. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•owner_id: número de id del usuario propietario de este producto. Si se omite, se usará el número de id de usuario autenticado.. Este parámetro debe ser un número en su modelo de Bizagi.
•prices: Matriz de objetos, cada uno contiene: moneda (string), precio (número), costo (número, opcional), costo_encabezado (número, opcional). Tenga en cuenta que solo puede haber un precio por producto por moneda. Cuando se omiten los "precios", no se establecerán precios para el producto.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Products.
Delete a product (Eliminar un producto)
Esta acción elimina un producto.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id del producto. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Products.
Get one product (Obtener one product)
Esta acción obtiene información detallada de un producto.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id del producto. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Products.
Get deals where a product is attached to (Obtener acuerdos que incluyan un producto)
Esta acción retorna un listado de acuerdos asociados a un producto.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id del producto. Este parámetro debe ser un número en su modelo de Bizagi.
•start: índice donde iniciara la busqueda. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: Items a mostrar por página. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Products.
Find products by name (Buscar productos por nombre)
Esta acción retorna un listado de productos filtrados por nombre.
Para configurar las entradas de esta acción tenga en cuenta:
•term (Requerido): palabra clave o término de búsqueda. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•currency: Código de la divisa en el que se deben devolver los precios. Si se omite, se devolverán los precios en la divisa predeterminada del usuario.
•start: índice donde iniciara la busqueda. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: Items a mostrar por página. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Products.
Get all products (Obtener todos los productos)
Esta acción retorna un listado de todos los productos.
Para configurar las entradas de esta acción tenga en cuenta:
•start: índice donde iniciara la busqueda. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: Items a mostrar por página. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Products.
Add a new pipeline (Agregar un nuevo pipeline)
Esta acción agrega un nuevo pipeline.
Para configurar las entradas de esta acción tenga en cuenta:
•name (Requerido): nombre del pipeline. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•deal_probability: indica si la probabilidad del acuerdo está deshabilitada o habilitada para este pipeline.. Este parámetro debe ser un número en su modelo de Bizagi.
•order_nr: Define el orden de los pipelines. Primer orden (order_nr = 0) es el pipeline predeterminado.. Este parámetro debe ser un número en su modelo de Bizagi.
•active: Si este pipeline estará inactivo (oculto) o activo. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Pipelines.
Edit a pipeline (Actualizar un pipeline)
Esta acción actualiza la información de un pipeline existente.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id del pipeline. Este parámetro debe ser un número en su modelo de Bizagi.
•name (Requerido): nombre del pipeline. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•deal_probability: indica si la probabilidad del acuerdo está deshabilitada o habilitada para este pipeline.. Este parámetro debe ser un número en su modelo de Bizagi.
•order_nr: Define el orden de los pipelines. Primer orden (order_nr = 0) es el pipeline predeterminado.. Este parámetro debe ser un número en su modelo de Bizagi.
•active: Si este pipeline estará inactivo (oculto) o activo. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Pipelines.
Delete a pipeline (Eliminar un pipeline)
Esta acción elimina un pipeline.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id del pipeline. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Pipelines.
Get all pipelines (Obtener todos los pipelines)
Esta acción retorna un listado de pipelines.
Esta acción no requiere ningún parámetro de entrada.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Pipelines.
Get one pipeline (Obtener un solo pipeline)
Esta acción obtiene la información de un pipeline.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id del pipeline. Este parámetro debe ser un número en su modelo de Bizagi.
•totals_convert_currency: Código de divisa de 3 letras. Puede establecer este parámetro en 'default_currency' se usa la moneda predeterminada del usuario.. Este parámetro debe ser de tipo String en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Pipelines.
Get deals in a pipeline (Obtener acuerdos de un pipeline)
Esta acción obtiene los acuerdos asociados a un pipeline.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id del pipeline. Este parámetro debe ser un número en su modelo de Bizagi.
•user_id: Si se proporciona, solo se devolverán los acuerdos del usuario ingresado. Si se omite, se devolverán los acuerdos del usuario autenticado.. Este parámetro debe ser un número en su modelo de Bizagi.
•stage_id: Si se proporciona, solo se devolverán los acuerdos en la etapa determinada.. Este parámetro debe ser un número en su modelo de Bizagi.
•start: índice donde iniciara la busqueda. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: Items a mostrar por página. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Pipelines.
Add a new stage (Agregar una nueva etapa)
Esta acción agrega una nueva etapa a un pipeline existente.
Para configurar las entradas de esta acción tenga en cuenta:
•name (Requerido): nombre de la etapa. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•pipeline_id (Requerido): número de id del pipeline. Este parámetro debe ser un número en su modelo de Bizagi.
•deal_probability: porcentaje de probabilidad de éxito. Usado/mostrado cuando se usan valores ponderados del acuerdo. Este parámetro debe ser un número en su modelo de Bizagi.
•rotten_flag: indica si los acuerdos en esta etapa pueden dañarse. Este parámetro debe ser un número en su modelo de Bizagi.
•rotten_days: Número de días en que los acuerdos no actualizados en esta etapa se dañarán. Solo se aplica si se usa el campo rotten_flag.. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Stages.
Update stage details (Actualizar detalles de una etapa)
Esta acción actualiza los detalles de una etapa.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la etapa a actualizar. Este parámetro debe ser un número en su modelo de Bizagi.
•name (Requerido): nombre del stage. Este parámetro debe ser de tipo String en su modelo de Bizagi.
•pipeline_id (Requerido): número de id del pipeline. Este parámetro debe ser un número en su modelo de Bizagi.
•deal_probability: porcentaje de probabilidad de éxito. Usado/mostrado cuando se usan valores ponderados del acuerdo. Este parámetro debe ser un número en su modelo de Bizagi.
•rotten_flag: indica si los acuerdos en esta etapa pueden dañarse. Este parámetro debe ser un número en su modelo de Bizagi.
•rotten_days: Número de días en que los acuerdos no actualizados en esta etapa se dañarán. Solo se aplica si se usa el campo rotten_flag.. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Stages.
Get one stage (Obtener una etapa)
Esta acción obtiene información de una etapa.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la etapa. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Stages.
Delete a stage (Eliminar una etapa)
Esta acción elimina una etapa.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la etapa. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Stages.
Get all stages (Obtener todas las etapas)
Esta acción retorna un listado de etapas filtrando por el número de id de un pipeline.
Para configurar las entradas de esta acción tenga en cuenta:
•pipeline_id: permite filtrar las etapas de un pipeline. Si se omite traerá todas las etapas disponibles. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Stages.
Get deals in a stage (Obtener los acuerdos de una etapa)
Esta acción retorna un listado de los acuerdos asociados a una etapa.
Para configurar las entradas de esta acción tenga en cuenta:
•id (Requerido): número de id de la etapa. Este parámetro debe ser un número en su modelo de Bizagi.
•user_id: Si se proporciona, solo se devolverán los acuerdos del usuario dado. Si se omite, se devolverán las acuerdos del usuario autenticado. Este parámetro debe ser un número en su modelo de Bizagi.
•everyone: Si se proporciona, se devolverán los acuerdos asociados a todos.. Este parámetro debe ser un número en su modelo de Bizagi.
•start: índice donde iniciara la busqueda. Este parámetro debe ser un número en su modelo de Bizagi.
•limit: Items a mostrar por página. Este parámetro debe ser un número en su modelo de Bizagi.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
Para más información de este método diríjase a la documentación oficial de Pipedrive - https://developers.pipedrive.com/docs/api/v1/#!/Stages.
Last Updated 10/28/2022 2:58:11 PM