Compartir a través de

Almabase (versión preliminar)

Almabase es el software de gestión de alumnos más querido del mundo para crear programas centrados en alumnos para aumentar la participación, la participación de los donantes y el hospedaje de comunidades en línea atractivas.

Este conector está disponible en los siguientes productos y regiones:

Service Class Regions
Copilot Studio Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Aplicaciones lógicas Estándar Todas las regiones de Logic Apps excepto las siguientes:
     - Regiones de Azure Government
     - Regiones de Azure China
     - Departamento de Defensa de EE. UU. (DoD)
Power Apps Premium Todas las regiones de Power Apps excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Power Automate Premium Todas las regiones de Power Automate excepto las siguientes:
     - Gobierno de EE. UU. (GCC)
     - Gobierno de EE. UU. (GCC High)
     - China Cloud operado por 21Vianet
     - Departamento de Defensa de EE. UU. (DoD)
Contacto
Nombre Compatibilidad con Almabase
URL https://docs.almabase.com
Correo Electrónico help@almabase.com
Metadatos del conector
Publicador Almabase, Inc.
Sitio web https://almabase.com
Directiva de privacidad https://www.almabase.com/ecloud-privacy-policy
Categorías Ventas y CRM; Productividad

Almabase proporciona herramientas de software y estrategias para las instituciones educativas para crear programas centrados en alumnos que convierten a los alumnos no comprometidos en seguidores de la vida.

Este conector se basa en las API y webhooks de Almabase y proporciona operaciones para ayudar a administrar las entidades que se encuentran en Almabase, entre las que se incluyen:

  • Registro (Constituyentes)
  • Regalos
  • Eventos
  • Puntos táctiles de Engagement
  • Formularios
  • Fondos
  • Páginas de entrega
  • Campañas de recaudación de fondos punto a punto
  • Y mucho más...

Prerrequisitos

Para usar este conector,

  • Debe tener una suscripción activa de Almabase.
  • Debe tener el rol de administrador del sitio.

Obtención de credenciales

  • Inicie sesión en el Portal de administración proporcionado por Almabase.
  • Vaya a API's & Tokens en Settings.
  • Haga clic en Add Auth Tokeny rellene descriptiony establezca el token expiry date & time.
  • Anote ( Workflow Access Token haga clic en el token para copiarlo en el Portapapeles).
  • Use al Workflow Access Token crear la nueva conexión en Power Automate.

Introducción al conector

Casos de uso comunes

  • Cuando se realiza un regalo, envíe un mensaje personalizado y un recibo de regalo.
  • Cuando se registra una actividad de interacción en Slack, Gmail o cualquier otro medio social, agregue la actividad de interacción a Engagement Studio en Almabase mediante Create Custom Touchpoint acción.
  • Cuando se encuentra una nueva dirección de correo electrónico (alumnos perdidos) en un Regalo o un registro de eventos o un envío de formulario, agregue esa dirección de correo electrónico a un registro en Almabase o un Constituyente en Raiser's Edge o un Contacto en Salesforce.
  • Diseñe la sincronización de datos bidireccionales entre Almabase y Blackbaud Raiser's Edge.
  • Diseñe la sincronización de datos bidireccionales entre Almabase y Salesforce.

Problemas y limitaciones conocidos

  • Los desencadenadores de regalo solo funcionan cuando el pago en línea se realiza en Almabase. Los regalos agregados manualmente no desencadenarían los flujos.

Creación de una conexión

El conector admite los siguientes tipos de autenticación:
Predeterminado Parámetros para crear una conexión. Todas las regiones No se puede compartir

Predeterminado

Aplicable: Todas las regiones

Parámetros para crear una conexión.

Esta conexión no se puede compartir. Si la aplicación de energía se comparte con otro usuario, se pedirá a otro usuario que cree explícitamente una nueva conexión.

Nombre Tipo Description Obligatorio
Dirección URL del dominio cuerda / cadena Especifique la dirección URL del dominio de Almabase, por ejemplo, https://your.domain.com Cierto
Clave de API securestring La clave de API del usuario Cierto

Limitaciones

Nombre Llamadas Período de renovación
Llamadas API por conexión 100 60 segundos

Acciones

Actualizar un evento

Actualiza un evento.
Actualizar un fondo

Actualiza un fondo.
Actualizar un regalo

Actualiza un regalo
Actualizar un registro

Actualiza un registro.
Actualizar una dirección de correo electrónico de un registro

Actualiza los campos de la dirección de correo electrónico de un registro.
Actualizar una persona de contacto

Actualiza una persona de contacto en un evento.
Agregar una persona de contacto

Agrega una persona de contacto a un evento.
Crear un evento

Crea un nuevo evento.
Crear un fondo

Crea un nuevo fondo.
Crear un punto de contacto

Envíe un nuevo punto táctil personalizado a Almabase.
Crear un regalo

Crea un nuevo regalo.
Crear un registro

Crea un nuevo registro.
Crear una dirección de correo electrónico para un registro

Crea una nueva dirección de correo electrónico para un registro.
Eliminar una dirección de correo electrónico de un registro

Elimine una dirección de correo electrónico de un registro.
Enumerar direcciones de correo electrónico de un registro

Devuelve una lista de direcciones de correo electrónico de un registro.
Enumerar fondos

Devuelve una lista de fondos
Enumerar personas de contacto

Devuelve una lista de todas las personas de contacto de un evento.
Enumerar páginas de entrega

Devuelve una lista de páginas que se proporcionan.
Enumerar regalos

Devuelve una lista de regalos.
Enumerar registros

Devuelve una lista de registros.
Enviar un formulario

Crea un nuevo envío de formulario para un formulario
Formularios de lista

Obtener una lista de formularios.
Lista de eventos

Devuelve una lista de todos los eventos.
Obtener un envío de un formulario

Devuelve información sobre un envío de formulario.
Obtener un evento

Devuelve información sobre un evento.
Obtener un fondo

Devuelve información sobre un fondo.
Obtener un regalo

Devuelve información sobre un regalo.
Obtener un registro

Devuelve información sobre un registro.
Obtener una dirección de correo electrónico de un registro

Devuelve información sobre una dirección de correo electrónico de un registro.
Obtener una página de entrega

Devuelve información sobre una página de entrega.

Actualizar un evento

Id. de la operación:
UpdateEvent

Actualiza un evento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. del evento
 id True integer

Identificador generado por el sistema para identificar de forma única un evento.
Description
 description string

Descripción del evento
Hora de finalización
 end_datetime string

Hora de finalización del evento
Id. de base de datos externa
 external_database_id string

Identificador único asignado por el sistema para el registro por parte de la base de datos externa. Por ejemplo, el identificador de registro del sistema para Raiser EdgeNAME, el identificador de contacto para Salesforce
Dirección URL de registro externo
 external_registration_url string

Dirección URL de registro del evento en un sitio web externo
Nombre
 name string

Nombre del evento
Hora de comienzo
 start_datetime string

Hora de inicio del evento
Timezone
 timezone string

Zona horaria del evento
Nombre
 display_name string

Ciudad,Estado,País del lugar

Devoluciones

Event

Body
v1.EventApi.EventRead

Actualizar un fondo

Id. de la operación:
UpdateFund

Actualiza un fondo.

Parámetros

Nombre Clave Requerido Tipo Description
Id. del fondo
 id True integer

Identificador generado por el sistema para identificar de forma única un fondo.
Id. de base de datos externa
 external_database_id string

Un identificador único asignado por el sistema para el fondo por la base de datos externa. Por ejemplo, el identificador de registro del sistema para Raiser Edge STORAGE, el identificador de objeto para Salesforce
¿Es el fondo predeterminado?
 is_default boolean

Indica que se han asociado todas las divisiones a este fondo si no se define ningún otro fondo en página de entrega.
¿Hay otro fondo?
 is_other_fund boolean

Indica que los donantes de este fondo han dado un nombre de fondo personalizado.
Nombre del fondo
 name True string

Nombre del fondo

Devoluciones

El fondo asociado a la división de regalos.

Fondo
v1.GivingApi.FundRead

Actualizar un regalo

Id. de la operación:
UpdateGift

Actualiza un regalo

Parámetros

Nombre Clave Requerido Tipo Description
Id. de regalo
 id True integer

Identificador generado por el sistema para identificar de forma única un regalo.
Número de lote
 batch_number string

Número de lote del regalo.
Dirección del donante: línea 1
 donor_address_line1 string

Línea de dirección 1 utilizada por el donante para el regalo.
Dirección del donante: línea 2
 donor_address_line2 string

Línea de dirección 2 utilizada por el donante para el regalo.
Nombre: Ciudad, Estado, País
 name string

La ciudad del donante. Formato: Nombre de ciudad, Nombre de estado corto, Nombre de país corto
Nombre del donante
 donor_name string

Nombre completo del donante.
Número de teléfono del donante
 donor_phone_number string

Número de teléfono utilizado por el donante para el regalo.
Dirección del donante: código postal
 donor_zip_code string

El código postal de la dirección utilizada por el donante para el regalo.
¿Está oculto de la tabla de clasificación?
 exclude_from_leaderboard boolean

¿Está oculto de la tabla de clasificación?
Id. de base de datos externa
 external_database_id string

Identificador único asignado por el sistema para el regalo por parte de la base de datos externa.
Mensaje de homenaje
 honor_message string

Un mensaje para un homenaje de regalo.
Prefijo de homenaje
 honor_prefix string

Prefijo para un homenaje de regalo. Las opciones disponibles son in_honor_of, in_memory_of, in_support_of
¿Es anónimo?
 is_anonymous boolean

Indica que el deseo del donante es ser anónimo para otros donantes para este don.
Nota:
 note string

Texto de la nota.
Otro nombre del fondo
 other_fund_name string

Cuando el donante selecciona un fondo marcado como is_other_fund, agregan un nombre de fondo personalizado para atribuir el regalo.
Página de entrega
 id integer

Identificador generado por el sistema para identificar de forma única una página de entrega.
identificación
 id integer

Identificador generado por el sistema para identificar de forma única un registro.
Importe
 amount True string

Cantidad de la división del regalo.
Fondo
 id True integer

Identificador generado por el sistema para identificar de forma única un fondo.

Devoluciones

Regalo

Body
v1.GivingApi.GiftRead

Actualizar un registro

Id. de la operación:
UpdateRecord

Actualiza un registro.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de registro
 id True integer

Identificador generado por el sistema para identificar de forma única un registro.
Id. de base de datos externa
 external_database_id string

Identificador único asignado por el sistema para el registro por parte de la base de datos externa. Por ejemplo, el identificador de registro del sistema para Raiser EdgeNAME, el identificador de contacto para Salesforce
Id. de búsqueda de base de datos externa
 external_database_lookup_id string

Identificador de búsqueda personalizado definido por el usuario para el registro en la base de datos externa. Por ejemplo, el identificador constituyente
Nombre
 first_name string

Nombre del registro.
Apellido
 last_name string

Apellidos del registro.

Devoluciones

registro

Body
v1.RecordApi.RecordRead

Actualizar una dirección de correo electrónico de un registro

Id. de la operación:
UpdateRecordEmailAddress

Actualiza los campos de la dirección de correo electrónico de un registro.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de registro
 record_id True integer

Identificador generado por el sistema para identificar de forma única un registro.
Id. de dirección de correo electrónico
 email_id True integer

Identificador generado por el sistema para identificar de forma única una dirección de correo electrónico de un registro.
¿Se usa para el inicio de sesión?
 is_login_email boolean

Indica si el usuario puede iniciar sesión en la Plataforma mediante esta dirección de correo electrónico.
¿Es principal?
 is_primary boolean

Se usa un correo electrónico principal para enviar los correos electrónicos automatizados desencadenados por el sistema. También se usa para enviar el correo electrónico masivo al perfil. Es obligatorio que solo se establezca un correo electrónico como principal.
Estado
 status string

Estado de la dirección de correo electrónico
Tipo
 type string

Tipo del correo electrónico

Devoluciones

Dirección de correo electrónico

Body
v1.RecordApi.EmailAddressRead

Actualizar una persona de contacto

Id. de la operación:
UpdateEventContactPerson

Actualiza una persona de contacto en un evento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. del evento
 id True integer

Identificador generado por el sistema para identificar de forma única un evento.
Identificador de persona de contacto de evento
 person_id True integer

Identificador generado por el sistema para identificar de forma única a una persona de contacto en un evento.
Correo Electrónico
 email email

Correo electrónico de la persona de contacto
Nombre
 name string

Nombre de la persona de contacto
Número de teléfono
 phone_number string

Número de teléfono de la persona de contacto

Devoluciones

Persona de contacto de un evento

Body
v1.EventApi.ContactPersonRead

Agregar una persona de contacto

Id. de la operación:
AddEventContactPerson

Agrega una persona de contacto a un evento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. del evento
 id True integer

Identificador generado por el sistema para identificar de forma única un evento.
Correo Electrónico
 email email

Correo electrónico de la persona de contacto
Nombre
 name string

Nombre de la persona de contacto
Número de teléfono
 phone_number string

Número de teléfono de la persona de contacto

Devoluciones

Persona de contacto de un evento

Body
v1.EventApi.ContactPersonRead

Crear un evento

Id. de la operación:
CreateEvent

Crea un nuevo evento.

Parámetros

Nombre Clave Requerido Tipo Description
Description
 description string

Descripción del evento
Hora de finalización
 end_datetime string

Hora de finalización del evento
Id. de base de datos externa
 external_database_id string

Identificador único asignado por el sistema para el registro por parte de la base de datos externa. Por ejemplo, el identificador de registro del sistema para Raiser EdgeNAME, el identificador de contacto para Salesforce
Dirección URL de registro externo
 external_registration_url string

Dirección URL de registro del evento en un sitio web externo
Nombre
 name True string

Nombre del evento
Hora de comienzo
 start_datetime string

Hora de inicio del evento
Timezone
 timezone string

Zona horaria del evento
Nombre
 display_name string

Ciudad,Estado,País del lugar

Devoluciones

Event

Body
v1.EventApi.EventRead

Crear un fondo

Id. de la operación:
CreateFund

Crea un nuevo fondo.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de base de datos externa
 external_database_id string

Un identificador único asignado por el sistema para el fondo por la base de datos externa. Por ejemplo, el identificador de registro del sistema para Raiser Edge STORAGE, el identificador de objeto para Salesforce
¿Es el fondo predeterminado?
 is_default boolean

Indica que se han asociado todas las divisiones a este fondo si no se define ningún otro fondo en página de entrega.
¿Hay otro fondo?
 is_other_fund boolean

Indica que los donantes de este fondo han dado un nombre de fondo personalizado.
Nombre del fondo
 name True string

Nombre del fondo

Devoluciones

El fondo asociado a la división de regalos.

Fondo
v1.GivingApi.FundRead

Crear un punto de contacto

Id. de la operación:
createTouchpointCustomObject

Envíe un nuevo punto táctil personalizado a Almabase.

Parámetros

Nombre Clave Requerido Tipo Description
Programa
 touchpoint_program True integer

Filtra los tipos por programas de punto de contacto.
Correo Electrónico
 email email

Identificador de correo electrónico usado para la actividad.
identificación
 id integer

Identificador generado por el sistema para identificar de forma única un registro.
Grabado en
 recorded_at True date-time

Marca de tiempo de la actividad.
Tipo
 id True integer

Devoluciones

Cuerpo del punto de contacto para crear un nuevo punto táctil

Body
v1.AlmasightsApi.TouchpointCustomObjectAdd

Crear un regalo

Id. de la operación:
CreateGift

Crea un nuevo regalo.

Parámetros

Nombre Clave Requerido Tipo Description
Cantidad de regalo
 amount True string

Cantidad de regalo con dos decimales.
Número de lote
 batch_number string

Número de lote del regalo.
Fecha de regalo
 completed_at True date-time

Fecha en la que el estado del regalo se marca como completado.
Moneda
 currency True integer

Moneda utilizada por el donante para el regalo.
Dirección del donante: línea 1
 donor_address_line1 string

Línea de dirección 1 utilizada por el donante para el regalo.
Dirección del donante: línea 2
 donor_address_line2 string

Línea de dirección 2 utilizada por el donante para el regalo.
Nombre: Ciudad, Estado, País
 name string

La ciudad del donante. Formato: Nombre de ciudad, Nombre de estado corto, Nombre de país corto
Correo electrónico del donante
 donor_email True email

Id. de correo electrónico utilizado por el donante para el regalo.
Nombre del donante
 donor_name True string

Nombre completo del donante.
Número de teléfono del donante
 donor_phone_number string

Número de teléfono utilizado por el donante para el regalo.
Dirección del donante: código postal
 donor_zip_code string

El código postal de la dirección utilizada por el donante para el regalo.
¿Está oculto de la tabla de clasificación?
 exclude_from_leaderboard boolean

¿Está oculto de la tabla de clasificación?
Id. de base de datos externa
 external_database_id string

Identificador único asignado por el sistema para el regalo por parte de la base de datos externa.
Mensaje de homenaje
 honor_message string

Un mensaje para un homenaje de regalo.
Prefijo de homenaje
 honor_prefix string

Prefijo para un homenaje de regalo. Las opciones disponibles son in_honor_of, in_memory_of, in_support_of
¿Es anónimo?
 is_anonymous boolean

Indica que el deseo del donante es ser anónimo para otros donantes para este don.
Modo de pago
 mode True string

Modo de pago, ya sea en línea o sin conexión.
Nota:
 note string

Texto de la nota.
Otro nombre del fondo
 other_fund_name string

Cuando el donante selecciona un fondo marcado como is_other_fund, agregan un nombre de fondo personalizado para atribuir el regalo.
Página de entrega
 id integer

Identificador generado por el sistema para identificar de forma única una página de entrega.
identificación
 id integer

Identificador generado por el sistema para identificar de forma única un registro.
Importe
 amount True string

Cantidad de la división del regalo.
Fondo
 id True integer

Identificador generado por el sistema para identificar de forma única un fondo.
Estado
 status True string

Estado del regalo.

Devoluciones

Regalo

Body
v1.GivingApi.GiftRead

Crear un registro

Id. de la operación:
CreateRecord

Crea un nuevo registro.

Parámetros

Nombre Clave Requerido Tipo Description
Línea 1
 line1 True string

Línea 1 de la dirección
Línea 2
 line2 string

Línea 2 de la dirección
Nombre
 name string

Ciudad, Estado, País de la ubicación
Privacidad
 privacy string

privacidad
Tipo
 type True string

Tipo del número
Código postal
 zip_code string

Código postal de la dirección
Fecha de nacimiento
 date_of_birth string

Fecha de nacimiento.
Difunto
 deceased boolean

Difunto.
Dirección
 address email

La dirección de correo electrónico
¿Se usa para el inicio de sesión?
 is_login_email boolean

Indica si el usuario puede iniciar sesión en la Plataforma mediante esta dirección de correo electrónico.
¿Es principal?
 is_primary boolean

Se usa un correo electrónico principal para enviar los correos electrónicos automatizados desencadenados por el sistema. También se usa para enviar el correo electrónico masivo al perfil. Es obligatorio que solo se establezca un correo electrónico como principal.
Fuente
 source string

El origen indica cómo se agrega el correo electrónico a la base de datos.
Estado
 status string

Estado de la dirección de correo electrónico
Tipo
 type string

Tipo del correo electrónico
Id. de base de datos externa
 external_database_id string

Identificador único asignado por el sistema para el registro por parte de la base de datos externa. Por ejemplo, el identificador de registro del sistema para Raiser EdgeNAME, el identificador de contacto para Salesforce
Id. de búsqueda de base de datos externa
 external_database_lookup_id string

Identificador de búsqueda personalizado definido por el usuario para el registro en la base de datos externa. Por ejemplo, el identificador constituyente
Nombre
 first_name True string

Nombre del registro.
Apellido
 last_name True string

Apellidos del registro.
Nombre intermedio
 middle_name string

Nombre intermedio del registro.
Number
 number True string

Number
Privacidad
 privacy string

privacidad
Tipo
 type True string

Tipo del número

Devoluciones

registro

Body
v1.RecordApi.RecordRead

Crear una dirección de correo electrónico para un registro

Id. de la operación:
CreateRecordEmailAddress

Crea una nueva dirección de correo electrónico para un registro.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de registro
 record_id True integer

Identificador generado por el sistema para identificar de forma única un registro.
Dirección
 address email

La dirección de correo electrónico
¿Se usa para el inicio de sesión?
 is_login_email boolean

Indica si el usuario puede iniciar sesión en la Plataforma mediante esta dirección de correo electrónico.
¿Es principal?
 is_primary boolean

Se usa un correo electrónico principal para enviar los correos electrónicos automatizados desencadenados por el sistema. También se usa para enviar el correo electrónico masivo al perfil. Es obligatorio que solo se establezca un correo electrónico como principal.
Fuente
 source string

El origen indica cómo se agrega el correo electrónico a la base de datos.
Estado
 status string

Estado de la dirección de correo electrónico
Tipo
 type string

Tipo del correo electrónico

Devoluciones

Dirección de correo electrónico

Body
v1.RecordApi.EmailAddressRead

Eliminar una dirección de correo electrónico de un registro

Id. de la operación:
DeleteRecordEmailAddress

Elimine una dirección de correo electrónico de un registro.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de registro
 record_id True integer

Identificador generado por el sistema para identificar de forma única un registro.
identificación
 email_id True integer

Identificador generado por el sistema para identificar de forma única una dirección de correo electrónico de un registro.

Enumerar direcciones de correo electrónico de un registro

Id. de la operación:
ListRecordEmailAddresses

Devuelve una lista de direcciones de correo electrónico de un registro.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de registro
 record_id True integer

Identificador generado por el sistema para identificar de forma única un registro.
¿Es principal?
 is_primary boolean

Busque el correo electrónico principal.
Fields
 fields array

Lista separada por comas de campos en la respuesta.
Tamaño de página
 page_size integer

Representa el número de registros que se van a devolver. El valor predeterminado es 10. El máximo es 50.
Número de página
 page integer

Representa los números de página (desplazamiento). Para su uso con paginación.

Devoluciones

Nombre Ruta de acceso Tipo Description
Dirección URL de resultados siguientes
 nextlink uri

Dirección URL del conjunto de resultados de la página siguiente. Para su uso con paginación.
Dirección URL de resultados anteriores
 previouslink uri

Dirección URL del conjunto anterior de resultados. Para su uso con paginación.
Total de direcciones de correo electrónico
 total integer

Total de direcciones de correo electrónico para los filtros especificados
Dirección de correo electrónico
 value array of v1.RecordApi.EmailAddressRead

Lista de direcciones de correo electrónico de un registro devuelto para los filtros especificados. Los resultados se paginan.

Enumerar fondos

Id. de la operación:
ListFunds

Devuelve una lista de fondos

Parámetros

Nombre Clave Requerido Tipo Description
Fields
 fields array

Lista separada por comas de campos en la respuesta.

Devoluciones

response
array of v1.GivingApi.FundRead

Enumerar personas de contacto

Id. de la operación:
ListEventContactPersons

Devuelve una lista de todas las personas de contacto de un evento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. del evento
 id True integer

Identificador generado por el sistema para identificar de forma única un evento.

Devoluciones

response
array of v1.EventApi.ContactPersonRead

Enumerar páginas de entrega

Id. de la operación:
ListGivingPages

Devuelve una lista de páginas que se proporcionan.

Parámetros

Nombre Clave Requerido Tipo Description
Fields
 fields array

Lista separada por comas de campos en la respuesta.

Devoluciones

response
array of v1.GivingApi.GivingPageRead

Enumerar regalos

Id. de la operación:
ListGifts

Devuelve una lista de regalos.

Parámetros

Nombre Clave Requerido Tipo Description
Estado
 status True string

Filtre los regalos según el estado.
Página de entrega
 campaign integer

Identificador generado por el sistema para identificar de forma única una página de entrega.
Filtrar por identificador de grupo de regalos
 group_id uuid

Identificador generado por el sistema para identificar de forma única un grupo de regalos o una lista.
¿Debe haber un número de lote vacío?
 batch_number__isnull boolean

Filtre los regalos en función de que tengan un número de lote o no.
¿Debe haber un identificador de base de datos externo vacío?
 external_database_id__isnull boolean

Filtre los regalos en función de que ya tengan el identificador de base de datos externo o no. NOTA: Los regalos que tienen el identificador de base de datos externo ya se insertan en la base de datos externa.
Filtrar por identificador de base de datos externo
 external_database_id string

Filtre los regalos en función del identificador de base de datos externo.
Filtrar por correo electrónico de donante
 donor_email string

Filtrar regalos en función de la dirección de correo electrónico del donante
Buscar por
 search string

Busque regalos por nombre o dirección de correo electrónico.
Fields
 fields array

Lista separada por comas de campos en la respuesta.
Tamaño de página
 page_size integer

Representa el número de registros que se van a devolver. El valor predeterminado es 10. El máximo es 50.
Número de página
 page integer

Representa los números de página (desplazamiento). Para su uso con paginación.
Ordenar por
 ordering string

Defina el orden de los regalos en la respuesta. Un prefijo "-" representa el orden descendente y la ausencia del prefijo devolvería los resultados en orden ascendente.

Devoluciones

Nombre Ruta de acceso Tipo Description
Dirección URL de resultados siguientes
 nextlink uri

Dirección URL del conjunto de resultados de la página siguiente. Para su uso con paginación.
Dirección URL de resultados anteriores
 previouslink uri

Dirección URL del conjunto anterior de resultados. Para su uso con paginación.
Total de regalos
 total integer

Total de regalos para los filtros dados
Regalos
 value array of v1.GivingApi.GiftRead

Lista de regalos devueltos para los filtros especificados. Los resultados se paginan.

Enumerar registros

Id. de la operación:
ListRecords

Devuelve una lista de registros.

Parámetros

Nombre Clave Requerido Tipo Description
Buscar por nombre
 search string

Busque registros por nombre.
Buscar por dirección de correo electrónico
 email_addresses__address string

Busque registros por dirección de correo electrónico.
Buscar por identificador de base de datos externo
 external_database_id string

Busque registros por identificador de base de datos externo.
Fields
 fields array

Lista separada por comas de campos en la respuesta.
Actualizado en o después
 updated_at__gte date-time

Actualizado en o después de una fecha.
Creado en o después
 created_at__gte date-time

Creado en o después de una fecha.
Tamaño de página
 page_size integer

Representa el número de registros que se van a devolver. El valor predeterminado es 10. El máximo es 50.
Número de página
 page integer

Representa los números de página (desplazamiento). Para su uso con paginación.

Devoluciones

Nombre Ruta de acceso Tipo Description
Dirección URL de resultados siguientes
 nextlink uri

Dirección URL del conjunto de resultados de la página siguiente. Para su uso con paginación.
Dirección URL de resultados anteriores
 previouslink uri

Dirección URL del conjunto anterior de resultados. Para su uso con paginación.
Total de registros
 total integer

Total de registros para los filtros especificados
Registros
 value array of v1.RecordApi.RecordRead

Lista de registros de un registro devuelto para los filtros especificados.

Enviar un formulario

Id. de la operación:
CreateFormEntry

Crea un nuevo envío de formulario para un formulario

Parámetros

Nombre Clave Requerido Tipo Description
Formulario
 form_id True integer

Identificador generado por el sistema para identificar de forma única un formulario.
body
 body dynamic

Crear un nuevo envío de formulario

Devoluciones

Nombre Ruta de acceso Tipo Description
Id. de respuesta
 id integer

Identificador generado por el sistema para identificar de forma única un envío de formulario.

Formularios de lista

Id. de la operación:
ListForms

Obtener una lista de formularios.

Parámetros

Nombre Clave Requerido Tipo Description
Fields
 fields array

Lista separada por comas de campos en la respuesta.

Devoluciones

response
array of v1.FormApi.FormRead

Lista de eventos

Id. de la operación:
ListEvents

Devuelve una lista de todos los eventos.

Parámetros

Nombre Clave Requerido Tipo Description
Buscar por identificador de base de datos externo
 external_database_id string

Busque eventos por identificador de base de datos externo.
Fields
 fields array

Lista separada por comas de campos en la respuesta.

Devoluciones

response
array of v1.EventApi.EventRead

Obtener un envío de un formulario

Id. de la operación:
GetFormEntry

Devuelve información sobre un envío de formulario.

Parámetros

Nombre Clave Requerido Tipo Description
Formulario
 form_id True integer

Identificador generado por el sistema para identificar de forma única un formulario.
Id. de respuesta
 entry_id True string

Identificador generado por el sistema para identificar de forma única un envío de formulario.

Devoluciones

Las salidas de esta operación son dinámicas.

Obtener un evento

Id. de la operación:
GetEvent

Devuelve información sobre un evento.

Parámetros

Nombre Clave Requerido Tipo Description
Id. del evento
 id True integer

Identificador generado por el sistema para identificar de forma única un evento.
Fields
 fields array

Lista separada por comas de campos en la respuesta.

Devoluciones

Event

Body
v1.EventApi.EventRead

Obtener un fondo

Id. de la operación:
GetFund

Devuelve información sobre un fondo.

Parámetros

Nombre Clave Requerido Tipo Description
Id. del fondo
 id True integer

Identificador generado por el sistema para identificar de forma única un fondo.
Fields
 fields array

Lista separada por comas de campos en la respuesta.

Devoluciones

El fondo asociado a la división de regalos.

Fondo
v1.GivingApi.FundRead

Obtener un regalo

Id. de la operación:
GetGift

Devuelve información sobre un regalo.

Parámetros

Nombre Clave Requerido Tipo Description
Id. de regalo
 id True integer

Identificador generado por el sistema para identificar de forma única un regalo.
Fields
 fields array

Lista separada por comas de campos en la respuesta.

Devoluciones

Regalo

Body
v1.GivingApi.GiftRead

Obtener un registro

Id. de la operación:
GetRecord

Devuelve información sobre un registro.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de registro
 id True integer

Identificador generado por el sistema para identificar de forma única un registro.
Fields
 fields array

Lista separada por comas de campos en la respuesta.

Devoluciones

registro

Body
v1.RecordApi.RecordRead

Obtener una dirección de correo electrónico de un registro

Id. de la operación:
GetRecordEmailAddress

Devuelve información sobre una dirección de correo electrónico de un registro.

Parámetros

Nombre Clave Requerido Tipo Description
Identificador de registro
 record_id True integer

Identificador generado por el sistema para identificar de forma única un registro.
identificación
 email_id True integer

Identificador generado por el sistema para identificar de forma única una dirección de correo electrónico de un registro.

Devoluciones

Dirección de correo electrónico

Body
v1.RecordApi.EmailAddressRead

Obtener una página de entrega

Id. de la operación:
GetGivingPage

Devuelve información sobre una página de entrega.

Parámetros

Nombre Clave Requerido Tipo Description
Dar id. de página
 id True integer

Identificador generado por el sistema para identificar de forma única una página de entrega.
Fields
 fields array

Lista separada por comas de campos en la respuesta.

Devoluciones

Página de entrega

Body
v1.GivingApi.GivingPageRead

Desencadenadores

Cuando se crea, actualiza o elimina un correo electrónico en un registro

Se desencadena cuando se crea un nuevo correo electrónico en un registro o se actualiza o se elimina de un registro.
Cuando se crea o actualiza un registro en Almabase

Se desencadena cuando se crea un nuevo registro en Almabase o se actualiza un registro existente.
Cuando se envía un formulario o se actualiza un envío de formulario existente

Se desencadena cuando se envía un formulario o se actualiza un envío de formulario existente.
Cuando un nuevo regalo es correcto o se produce un error en el pago de un regalo en línea

Se desencadena cuando se registra correctamente un nuevo regalo en una página de entrega por un donante o se produce un error en el pago a un regalo.

Cuando se crea, actualiza o elimina un correo electrónico en un registro

Id. de la operación:
EmailChangedWebhook

Se desencadena cuando se crea un nuevo correo electrónico en un registro o se actualiza o se elimina de un registro.

Parámetros

Nombre Clave Requerido Tipo Description
Cuando
 events True string

Lista de eventos que se van a desencadenar el flujo.

Devoluciones

Body
v1.RecordApi.EmailWebhookResponse

Cuando se crea o actualiza un registro en Almabase

Id. de la operación:
RecordChangedWebhook

Se desencadena cuando se crea un nuevo registro en Almabase o se actualiza un registro existente.

Parámetros

Nombre Clave Requerido Tipo Description
Cuando
 events True string

Lista de eventos que se van a desencadenar el flujo.

Devoluciones

Body
v1.RecordApi.RecordWebhookResponse

Cuando se envía un formulario o se actualiza un envío de formulario existente

Id. de la operación:
FormEntryCreateOrUpdateWebhook

Se desencadena cuando se envía un formulario o se actualiza un envío de formulario existente.

Parámetros

Nombre Clave Requerido Tipo Description
Cuando
 events True string

Lista de eventos que se van a desencadenar el flujo.
Formulario
 object_id True integer

Identificador generado por el sistema para identificar de forma única un formulario.

Devoluciones

Las salidas de esta operación son dinámicas.

Cuando un nuevo regalo es correcto o se produce un error en el pago de un regalo en línea

Id. de la operación:
GiftSucceededOrFailedWebhook

Se desencadena cuando se registra correctamente un nuevo regalo en una página de entrega por un donante o se produce un error en el pago a un regalo.

Parámetros

Nombre Clave Requerido Tipo Description
Cuando
 events True string

Lista de eventos que se van a desencadenar el flujo.
Página de entrega
 object_id integer

Identificador generado por el sistema para identificar de forma única una página de entrega.

Devoluciones

Body
v1.GivingApi.GiftWebhookResponse

Definiciones

v1. FormApi.FormRead

Formulario

Nombre Ruta de acceso Tipo Description
identificación
 id integer

Identificador generado por el sistema para identificar de forma única un formulario.
Nombre del formulario
 title string

Nombre del formulario

v1. GivingApi.GiftWebhookRecordRead

Registro

Nombre Ruta de acceso Tipo Description
Id. de base de datos externa
 external_database_id string

Identificador único asignado por el sistema para el registro por parte de la base de datos externa. Por ejemplo, el identificador de registro del sistema para Raiser EdgeNAME, el identificador de contacto para Salesforce
Nombre
 first_name string

Nombre del registro asignado
identificación
 id integer

Identificador generado por el sistema para identificar de forma única un registro.
¿Está registrado el donante en Almabase?
 is_registered boolean

Indica si el registro asignado o el donante registrados en Almabase
Apellido
 last_name string

Apellidos del registro asignado

v1. GivingApi.GiftWebhookResponse

Nombre Ruta de acceso Tipo Description
Importe
 data.amount string

Cantidad de regalo con dos decimales.
Fecha
 data.completed_at date-time

Fecha en la que el estado del regalo se marca como completado.
Correo electrónico del donante
 data.email email

Id. de correo electrónico utilizado por el donante para el regalo.
Id. de base de datos externa
 data.external_database_id string

Identificador único asignado por el sistema para el regalo por parte de la base de datos externa.
identificación
 data.id integer

Identificador generado por el sistema para identificar de forma única un regalo.
¿Es nuevo correo electrónico?
 data.is_email_new boolean

Indica si el correo electrónico proporcionado por el donante ya existe en los registros de Almabase.
schema
 data.mapped_profile.schema v1.GivingApi.GiftWebhookRecordRead

Registro
Mode
 data.mode string

Modo del regalo.
Nombre del donante
 data.name string

Nombre completo del donante.
identificación
 data.page.id integer

Identificador generado por el sistema para identificar de forma única una página de entrega.
Nombre de página que da nombre a la página
 data.page.name string

Nombre de la página de concesión asociada
Estado
 data.status string

Estado del regalo.
Evento desencadenado en
 time string

Hora del evento.
Tipo de evento
 type string

El tipo de evento.

v1. GivingApi.LocationRead

La ciudad utilizada por el donante para el don.

Nombre Ruta de acceso Tipo Description
City
 city string

La ciudad del donante
Nombre corto de ciudad
 city_short_name string

Representación breve de la ciudad, por ejemplo, SF
Latitude
 coordinates.latitude string

Latitud de la ubicación
Longitude
 coordinates.longitude string

Longitud de la ubicación
País
 country string

País del donante
Nombre corto de país
 country_short_name string

Representación breve del país, por ejemplo, EE. UU.
Google Place Id
 gpid string

Identificador de lugar obtenido de Google
Ciudad, Estado, País
 name string

La ciudad del donante. Formato: Nombre de ciudad, Nombre de estado corto, Nombre de país corto
Estado
 state string

Estado del donante
Nombre corto de estado
 state_short_name string

Representación breve del estado, por ejemplo, CA

v1. GivingApi.FormFieldRead

Campo de formulario

Nombre Ruta de acceso Tipo Description
Importancia
 display_value string

Valor con formato especificado por los respondedor. Por ejemplo, nombre de la carga de archivos.
Nombre del campo pregunta/formulario
 label string

Nombre del campo de pregunta o formulario en el formulario

v1. GivingApi.FundRead

El fondo asociado a la división de regalos.

Nombre Ruta de acceso Tipo Description
Id. de base de datos externa
 external_database_id string

Un identificador único asignado por el sistema para el fondo por la base de datos externa. Por ejemplo, el identificador de registro del sistema para Raiser Edge STORAGE, el identificador de objeto para Salesforce
identificación
 id integer

Identificador generado por el sistema para identificar de forma única un fondo.
¿Es el fondo predeterminado?
 is_default boolean

Indica que se han asociado todas las divisiones a este fondo si no se define ningún otro fondo en página de entrega.
¿Hay otro fondo?
 is_other_fund boolean

Indica que los donantes de este fondo han dado un nombre de fondo personalizado.
Nombre
 name string

Nombre del fondo

v1. GivingApi.GiftRead

Regalo

Nombre Ruta de acceso Tipo Description
Cantidad de regalo
 amount string

Cantidad de regalo con dos decimales.
Número de lote
 batch_number string

Número de lote del regalo.
Fecha de regalo
 completed_at date-time

Fecha en la que el estado del regalo se marca como completado.
Moneda
 currency integer

Moneda utilizada por el donante para el regalo.
Device
 device string

Identifique el dispositivo usado para hacer el regalo, por ejemplo, pc, móvil o tableta.
Dirección del donante: línea 1
 donor_address_line1 string

Línea de dirección 1 utilizada por el donante para el regalo.
Dirección del donante: línea 2
 donor_address_line2 string

Línea de dirección 2 utilizada por el donante para el regalo.
Dirección del donante: Ubicación
 donor_city_place v1.GivingApi.LocationRead

La ciudad utilizada por el donante para el don.
Correo electrónico del donante
 donor_email email

Id. de correo electrónico utilizado por el donante para el regalo.
Nombre del donante
 donor_name string

Nombre completo del donante.
Número de teléfono del donante
 donor_phone_number string

Número de teléfono utilizado por el donante para el regalo.
Dirección del donante: código postal
 donor_zip_code string

El código postal de la dirección utilizada por el donante para el regalo.
¿Está oculto de la tabla de clasificación?
 exclude_from_leaderboard boolean

¿Está oculto de la tabla de clasificación?
Id. de base de datos externa
 external_database_id string

Identificador único asignado por el sistema para el regalo por parte de la base de datos externa.
Mensaje de homenaje
 honor_message string

Un mensaje para un homenaje de regalo.
Prefijo de homenaje
 honor_prefix string

Prefijo para un homenaje de regalo. Las opciones disponibles son in_honor_of, in_memory_of, in_support_of
identificación
 id integer

Identificador generado por el sistema para identificar de forma única un regalo.
Influenciador
 influencer v1.GivingApi.InfluencerRead

Vínculo de recurso compartido público y vínculo de panel privado
¿Es anónimo?
 is_anonymous boolean

Indica que el deseo del donante es ser anónimo para otros donantes para este don.
¿El donante ha cubierto los cargos de la puerta de enlace de pago?
 is_donor_covered_charges boolean

Indica si el donante ha optado por cubrir los cargos de la puerta de enlace de pago al hacer este regalo?
¿Se agrega correo electrónico a un registro en Almabase?
 is_email_added_to_profile boolean

Indica si el correo electrónico proporcionado por el donante se agrega en el registro almabase (independientemente de is_email_new estado)
¿Es nuevo correo electrónico?
 is_email_new boolean

Indica si el correo electrónico proporcionado por el donante ya existe en los registros de Almabase.
¿Se omite la asignación a un registro en Almabase?
 is_profile_mapping_ignored boolean

Indica si se debe omitir la asignación de registros.
Modo de pago
 mode string

Modo de pago, ya sea en línea o sin conexión.
Nota:
 note string

Texto de la nota.
Otro nombre del fondo
 other_fund_name string

Cuando el donante selecciona un fondo marcado como is_other_fund, agregan un nombre de fondo personalizado para atribuir el regalo.
Página de entrega
 page v1.GivingApi.GivingPageAssociatedWithGift

Página de entrega asociada al regalo.
Fields
 post_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
Id. de respuesta
 post_payment_form_entry.id integer

Identificador generado por el sistema para identificar de forma única un envío de formulario.
Fields
 pre_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
Id. de respuesta
 pre_payment_form_entry.id integer

Identificador generado por el sistema para identificar de forma única un envío de formulario.
Registro asignado
 profile v1.GivingApi.RecordRead

Registro asignado en Almabase
Vínculo del remitente
 referrer_link string

Vínculo al sitio web para identificar la fuente de la visita del donante. Por ejemplo, el donante visitó la campaña de donaciones de Facebook, Google, etc.
Importe de reembolso
 refund_amount string

Importe devuelto al donante. Si se devuelve el importe entero, el estado del regalo se reembolsará en lugar de completarse.
Divide
 splits array of v1.GivingApi.GiftSplitRead

Las divisiones asociadas al regalo.
Estado
 status string

Estado del regalo.
Transacción en línea
 transaction v1.GivingApi.TransactionRead

La transacción de pago en línea asociada al regalo.
Campaña UTM
 utm_campaign string

Se usa para el análisis de palabras clave. utm_campaign identificar una campaña estratégica o promoción de productos específica. Por ejemplo, annual_fund_2020
UTM Medium
 utm_medium string

utm_medium identificar un medio como el correo electrónico o el costo por clic. por ejemplo, cpc
Origen UTM
 utm_source string

utm_source identificar un motor de búsqueda, un nombre de boletín u otro origen. Por ejemplo, Google

v1. GivingApi.GiftSplitRead

División de regalo

Nombre Ruta de acceso Tipo Description
Importe
 amount string

Cantidad de la división del regalo.
Fondo
 fund v1.GivingApi.FundRead

El fondo asociado a la división de regalos.
identificación
 id integer

Identificador generado por el sistema para identificar de forma única una división de regalo.

v1. GivingApi.GivingPageAssociatedWithGift

Página de entrega asociada al regalo.

Nombre Ruta de acceso Tipo Description
identificación
 id integer

Identificador generado por el sistema para identificar de forma única una página de entrega.
Nombre
 name string

Nombre de la página de entrega asociada.

v1. GivingApi.GivingPageRead

Página de entrega

Nombre Ruta de acceso Tipo Description
identificación
 id integer

Identificador generado por el sistema para identificar de forma única una página de entrega.
Nombre
 name string

Nombre de la página de entrega

v1. GivingApi.InfluencerRead

Vínculo de recurso compartido público y vínculo de panel privado

Nombre Ruta de acceso Tipo Description
Vínculo de panel de influencia privada
 dashboard_url uri

Panel privado del donante para supervisar el número de visitas a páginas y regalos influenciados por ellos
Vínculo de recurso compartido público
 page_share_url uri

El vínculo público de dar página o campaña de donantes para realizar un seguimiento de la influencia en las visitas a Página de entrega y los regalos.

v1. GivingApi.PaymentAccountRead

La cuenta de pago asociada a la transacción, por ejemplo, BBMS, Stripe, PayPal, etc.

Nombre Ruta de acceso Tipo Description
identificación
 id integer

Identificador generado por el sistema para identificar de forma única una cuenta de pago.
Nombre
 name string

Nombre de la cuenta de pago.
Gateway
 type string

Nombre de la puerta de enlace de pago.

v1. GivingApi.RecordRead

Registro asignado en Almabase

Nombre Ruta de acceso Tipo Description
Id. de base de datos externa
 external_database_id string

Identificador único asignado por el sistema para el registro por parte de la base de datos externa. Por ejemplo, el identificador de registro del sistema para Raiser EdgeNAME, el identificador de contacto para Salesforce
Nombre
 first_name string

Nombre del registro asignado
Nombre completo
 formatted_name string

Nombre completo del registro asignado
identificación
 id integer

Identificador generado por el sistema para identificar de forma única un registro.
¿Está registrado el donante en Almabase?
 is_registered boolean

Indica si el registro asignado o el donante registrados en Almabase
Apellido
 last_name string

Apellidos del registro asignado
Dirección URL de imagen
 present_picture uri

Dirección URL de la imagen de registro
Link
 profile_url uri

Vínculo de registro en Almabase

v1. GivingApi.TransactionRead

La transacción de pago en línea asociada al regalo.

Nombre Ruta de acceso Tipo Description
Cuenta de pago
 account v1.GivingApi.PaymentAccountRead

La cuenta de pago asociada a la transacción, por ejemplo, BBMS, Stripe, PayPal, etc.
Creado en
 created_at date-time

Hora de creación de esta transacción.
Motivo del error
 failure_reason string

Motivo del error de transacción devuelto por la puerta de enlace de pago.
identificación
 id uuid

Identificador generado por el sistema para identificar de forma única una transacción.
Estado
 status integer

Estado de la transacción. - 1 (Sin procesar) - 2 (Correcto) - 3 (Error) - 4 (Pendiente) - 5 (Error) NOTA: Estos estados están asociados con el estado de la transacción por la puerta de enlace de pago
Identificador de referencia de la puerta de enlace de pago
 transaction_id string

Identificador único generado por la puerta de enlace de pago para identificar la transacción. Por ejemplo, el identificador de transacción de Blackbaud Merchant Services (BBMS) o el identificador de cargo de Stripe, PayPal id. de transacción

v1. AlmasightsApi.RecordAddOrEdit

Grabar en Almabase.

Nombre Ruta de acceso Tipo Description
identificación
 id integer

Identificador generado por el sistema para identificar de forma única un registro.

v1. AlmasightsApi.TouchpointCustomObjectAdd

Cuerpo del punto de contacto para crear un nuevo punto táctil

Nombre Ruta de acceso Tipo Description
Correo Electrónico
 email email

Identificador de correo electrónico usado para la actividad.
Registro
 mapped_profile v1.AlmasightsApi.RecordAddOrEdit

Grabar en Almabase.
Grabado en
 recorded_at date-time

Marca de tiempo de la actividad.
Tipo
 touchpoint_type.id integer

v1. RecordApi.LocationRead

Ubicación de la dirección

Nombre Ruta de acceso Tipo Description
City
 city string

Nombre de la ciudad de la ubicación
País
 country string

Nombre de país de la ubicación
Latitude
 latitude double

Latitud de la ubicación
Longitude
 longitude double

Longitud de la ubicación
Estado
 state string

Nombre de estado de la ubicación

v1. RecordApi.AddressRead

Dirección

Nombre Ruta de acceso Tipo Description
Line1
 line1 string

Línea 1 de la dirección
Line2
 line2 string

Línea 2 de la dirección
schema
 location.schema v1.RecordApi.LocationRead

Ubicación de la dirección
Código postal
 zipcode string

Código postal de la dirección

v1. RecordApi.EmailWebhookRecordRead

Registro

Nombre Ruta de acceso Tipo Description
Id. de base de datos externa
 external_database_id string

Identificador único asignado por el sistema para el registro por parte de la base de datos externa. Por ejemplo, el identificador de registro del sistema para Raiser EdgeNAME, el identificador de contacto para Salesforce
Nombre
 first_name string

Nombre del registro asignado
identificación
 id integer

Identificador generado por el sistema para identificar de forma única un registro.
¿Está registrado en Almabase?
 is_registered boolean

Indica si el registro asignado registrado en Almabase
Apellido
 last_name string

Apellidos del registro asignado

v1. RecordApi.EmailWebhookResponse

Nombre Ruta de acceso Tipo Description
Dirección de correo electrónico
 data.address email

Dirección de correo electrónico.
identificación
 data.id integer

Identificador generado por el sistema para identificar de forma única un correo electrónico.
Es principal
 data.is_primary boolean

Indica si el correo electrónico es principal o no.
schema
 data.profile.schema v1.RecordApi.EmailWebhookRecordRead

Registro
Tipo de correo electrónico
 data.type string

Tipo de dirección de correo electrónico (principal, personal, trabajo, etc.).
Evento desencadenado en
 time string

Hora del evento.
Tipo de evento
 type string

El tipo de evento.

v1. RecordApi.RecordWebhookResponse

Nombre Ruta de acceso Tipo Description
Afiliaciones
 data.affiliations array of string
Año de clase
 data.class_year string

Año de clase del registro
Dirección de correo electrónico
 data.email email

Dirección de correo electrónico.
Id. de base de datos externa
 data.external_database_id string

Identificador único asignado por el sistema para el registro por parte de la base de datos externa. Por ejemplo, el identificador de registro del sistema para Raiser EdgeNAME, el identificador de contacto para Salesforce
Nombre
 data.first_name string

Nombre del registro asignado
schema
 data.home_address.schema v1.RecordApi.AddressRead

Dirección
identificación
 data.id integer

Identificador generado por el sistema para identificar de forma única un registro.
Apellido
 data.last_name string

Apellidos del registro asignado
Fecha de expiración de pertenencia
 data.membership_expiry_date date-time

Fecha de expiración de la pertenencia al registro
Nombre del tipo de pertenencia
 data.membership_type_name string

Nombre del tipo de pertenencia del registro
Número de móvil
 data.mobile_number string

Número móvil del registro
schema
 data.office_address.schema v1.RecordApi.AddressRead

Dirección
Número de teléfono de la oficina
 data.office_phone_number string

Número de teléfono de la oficina del registro
Número de teléfono de residencia
 data.residence_phone_number string

Número de teléfono de residencia del registro
Evento desencadenado en
 time string

Hora del evento.
Tipo de evento
 type string

El tipo de evento.

v1. RecordApi.EmailAddressRead

Dirección de correo electrónico

Nombre Ruta de acceso Tipo Description
Dirección
 address email

La dirección de correo electrónico
identificación
 id integer

Identificador generado por el sistema para identificar de forma única una dirección de correo electrónico de un registro.
¿Está comprometido?
 is_engaged boolean

Indica si se hace clic o se abre un correo electrónico masivo o el usuario responde a uno a uno.
¿Se usa para el inicio de sesión?
 is_login_email boolean

Indica si el usuario puede iniciar sesión en la Plataforma mediante esta dirección de correo electrónico.
¿Es principal?
 is_primary boolean

Se usa un correo electrónico principal para enviar los correos electrónicos automatizados desencadenados por el sistema. También se usa para enviar el correo electrónico masivo al registro. Es obligatorio que solo se establezca un correo electrónico como principal.
¿Está comprobado por el usuario?
 is_verified boolean

Indique si el usuario ha comprobado que posee el correo electrónico.
source
 source string

El origen indica cómo se agrega el correo electrónico a la base de datos.
estado
 status string
Tipo
 type string

Tipo del correo electrónico

v1. RecordApi.RecordRead

registro

Nombre Ruta de acceso Tipo Description
Direcciones de correo electrónico
 email_addresses array of v1.RecordApi.EmailAddressRead

Lista de direcciones de correo electrónico de un perfil
Id. de base de datos externa
 external_database_id string

Identificador único asignado por el sistema para el registro por parte de la base de datos externa. Por ejemplo, el identificador de registro del sistema para Raiser EdgeNAME, el identificador de contacto para Salesforce
Nombre
 first_name string

Nombre del registro.
Nombre completo
 formatted_name string

Nombre completo del registro.
identificación
 id integer

Identificador generado por el sistema para identificar de forma única un registro.
¿Está registrado en Almabase?
 is_registered boolean

Indica si el registro o el donante registrados en Almabase
Apellido
 last_name string

Apellidos del registro.
Dirección URL de imagen
 present_picture uri

Dirección URL de la imagen de registro
Link
 record_url uri

Vínculo de registro en Almabase

v1. EventApi.ContactPersonRead

Persona de contacto de un evento

Nombre Ruta de acceso Tipo Description
Correo Electrónico
 email email

Correo electrónico de la persona de contacto
identificación
 id integer

Identificador generado por el sistema para identificar de forma única a una persona de contacto.
Nombre
 name string

Nombre de la persona de contacto
Número de teléfono
 phone_number string

Número de teléfono de la persona de contacto

v1. EventApi.EventRead

Event

Nombre Ruta de acceso Tipo Description
Description
 description string

Descripción del evento
Hora de finalización
 end_datetime string

Hora de finalización del evento
Id. de base de datos externa
 external_database_id string

Identificador único asignado por el sistema para el registro por parte de la base de datos externa. Por ejemplo, el identificador de registro del sistema para Raiser EdgeNAME, el identificador de contacto para Salesforce
Dirección URL de registro externo
 external_registration_url string

Dirección URL de registro del evento en un sitio web externo
identificación
 id integer

Identificador generado por el sistema para identificar de forma única un evento.
Nombre
 name string

Nombre del evento
Hora de comienzo
 start_datetime string

Hora de inicio del evento
Timezone
 timezone string

Zona horaria del evento