Compartilhar via

Almabase (versão prévia)

O Almabase é o software de gerenciamento de ex-alunos mais amado do mundo para criar programas centrados em ex-alunos para aumentar a participação, o engajamento de doadores e hospedar comunidades online envolventes.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte do Almabase
URL https://docs.almabase.com
Email help@almabase.com
Metadados do conector
Publicador Almabase, Inc.
Site https://almabase.com
Política de privacidade https://www.almabase.com/ecloud-privacy-policy
Categorias Vendas e CRM; Produtividade

O Almabase fornece ferramentas de software e estratégias para instituições educacionais criarem programas centrados em ex-alunos que transformam ex-alunos desengajados em apoiadores para toda a vida.

Esse conector é criado com base nas APIs do Almabase &webhooks e fornece operações para ajudar a gerenciar entidades encontradas no Almabase, incluindo:

  • Registro (Constituintes)
  • Presentes
  • Eventos
  • Pontos de contato do Engagement
  • Formulários
  • Fundos
  • Dando páginas
  • Campanhas de arrecadação de fundos ponto a ponto
  • e muito mais...

Pré-requisitos

Para usar esse conector,

  • Você deve ter uma assinatura ativa do Almabase.
  • Você deve ter a função de administrador do site.

Como obter credenciais

  • Faça logon no Portal de Administração fornecido pelo Almabase.
  • Navegue até API's & Tokens .Settings
  • Clique e Add Auth Tokenpreencha e descriptiondefina o token expiry date & time.
  • Anote o Workflow Access Token valor (clique no token a ser copiado na área de transferência).
  • Use o Workflow Access Token quando criar a nova conexão no Power Automate.

Introdução ao conector

Casos de Uso Comum

  • Quando um presente for feito, envie uma mensagem personalizada e um recibo de presente.
  • Quando uma atividade de engajamento é registrada no Slack, Gmail ou em qualquer outra mídia social, adicione a atividade de engajamento ao Engagement Studio no Almabase usando Create Custom Touchpoint a ação.
  • Quando um novo endereço de email for encontrado (ex-alunos perdidos) em um Presente ou um registro de evento ou um envio de formulário, adicione esse endereço de email a um registro no Almabase ou um Constituinte na Borda do Raiser ou em um Contato no Salesforce.
  • Projete a sincronização de dados bidirecional entre o Almabase e o Blackbaud Raiser's Edge.
  • Projete a sincronização de dados bidirecionais entre o Almabase e o Salesforce.

Problemas e limitações conhecidos

  • Os gatilhos de presente funcionam somente quando o pagamento online é feito no Almabase. Presentes adicionados manualmente não disparariam os fluxos.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:
Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
URL do Domínio cadeia Especifique a URL de domínio do Almabase, por exemplo, https://your.domain.com Verdade
Chave de API secureString A chave de API do usuário Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Adicionar uma pessoa de contato

Adiciona uma pessoa de contato a um evento.
Atualizar um endereço de email de um registro

Atualiza os campos do endereço de email de um registro
Atualizar um evento

Atualiza um evento.
Atualizar um fundo

Atualiza um fundo.
Atualizar um presente

Atualiza um presente
Atualizar um registro

Atualiza um registro.
Atualizar uma pessoa de contato

Atualiza uma pessoa de contato em um evento.
Criar um endereço de email para um registro

Cria um novo endereço de email para um registro.
Criar um evento

Cria um novo evento.
Criar um fundo

Cria um novo fundo.
Criar um ponto de toque

Envie um novo ponto de toque personalizado para o Almabase.
Criar um presente

Cria um novo presente.
Criar um registro

Cria um novo registro.
Enviar um formulário

Cria um novo envio de formulário para um formulário
Excluir um endereço de email de um registro

Exclua um endereço de email de um registro.
Formulários de lista

Obtenha uma lista de formulários.
Listar endereços de email de um registro

Retorna uma lista de endereços de email para um registro.
Listar eventos

Retorna uma lista de todos os eventos.
Listar fundos

Retorna uma lista de fundos
Listar pessoas de contato

Retorna uma lista de todas as pessoas de contato em um evento.
Listar presentes

Retorna uma lista de presentes.
Listar páginas de doação

Retorna uma lista de páginas de doação.
Listar registos

Retorna uma lista de registros.
Obter um endereço de email de um registro

Retorna informações sobre um endereço de email de um registro.
Obter um envio de um formulário

Retorna informações sobre um envio de formulário.
Obter um evento

Retorna informações sobre um evento.
Obter um fundo

Retorna informações sobre um fundo.
Obter um presente

Retorna informações sobre um presente.
Obter um registro

Retorna informações sobre um registro.
Obter uma página de doação

Retorna informações sobre uma página de doação.

Adicionar uma pessoa de contato

ID da operação:
AddEventContactPerson

Adiciona uma pessoa de contato a um evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
 id True integer

ID gerada pelo sistema para identificar exclusivamente um evento.
Email
 email email

Email da pessoa de contato
Nome
 name string

Nome da pessoa de contato
Número de Telefone
 phone_number string

Número de telefone da pessoa de contato

Retornos

Contate a pessoa de um evento

Corpo
v1.EventApi.ContactPersonRead

Atualizar um endereço de email de um registro

ID da operação:
UpdateRecordEmailAddress

Atualiza os campos do endereço de email de um registro

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Registro
 record_id True integer

ID gerada pelo sistema para identificar exclusivamente um registro.
ID do endereço de email
 email_id True integer

ID gerada pelo sistema para identificar exclusivamente um endereço de email de um registro.
Usar para logon?
 is_login_email boolean

Indica se o usuário tem permissão para fazer logon na Plataforma usando esse endereço de email.
É primário?
 is_primary boolean

Um email primário é usado para enviar os emails automatizados disparados pelo Sistema. Ele também é usado para enviar o email em massa para o perfil. É obrigatório que apenas um email seja definido como primário.
Situação
 status string

Status do endereço de email
Tipo
 type string

O tipo do email

Retornos

Endereço eletrônico

Corpo
v1.RecordApi.EmailAddressRead

Atualizar um evento

ID da operação:
UpdateEvent

Atualiza um evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
 id True integer

ID gerada pelo sistema para identificar exclusivamente um evento.
Description
 description string

Descrição do evento
Hora de Término
 end_datetime string

Hora de término do evento
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o registro pelo banco de dados externo. por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
URL de Registro Externo
 external_registration_url string

A URL de registro do evento em um site externo
Nome
 name string

Nome do evento
Hora de Início
 start_datetime string

Hora de início do evento
Timezone
 timezone string

Fuso horário do evento
Nome
 display_name string

Cidade, Estado, País do Local

Retornos

Event

Corpo
v1.EventApi.EventRead

Atualizar um fundo

ID da operação:
UpdateFund

Atualiza um fundo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do fundo
 id True integer

ID gerada pelo sistema para identificar exclusivamente um fundo.
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o fundo pelo banco de dados externo. por exemplo, ID de registro do sistema para Raiser Edge NXT, ID do objeto para Salesforce
O fundo padrão é?
 is_default boolean

Indica associar todas as divisões a esse fundo se nenhum outro fundo for definido na Página de Doação.
Outro fundo é?
 is_other_fund boolean

Indica que os doadores desse fundo deram o nome do fundo personalizado.
Nome do fundo
 name True string

Nome do fundo

Retornos

O fundo associado à divisão do presente.

Fundo
v1.GivingApi.FundRead

Atualizar um presente

ID da operação:
UpdateGift

Atualiza um presente

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do presente
 id True integer

ID gerada pelo sistema para identificar exclusivamente um presente.
Número do Lote
 batch_number string

O número do lote do presente.
Endereço do doador: Linha 1
 donor_address_line1 string

A linha de endereço 1 usada pelo doador para o presente.
Endereço do doador: Linha 2
 donor_address_line2 string

O endereço da linha 2 usado pelo doador para o presente.
Nome: Cidade, Estado, País
 name string

A cidade do doador. Formato: Nome da Cidade, Nome do Estado Curto, Nome do País Curto
Nome do doador
 donor_name string

Nome completo do doador.
Número de telefone do doador
 donor_phone_number string

Número de telefone usado pelo doador para o presente.
Endereço do doador: Cep
 donor_zip_code string

O cep do endereço usado pelo doador para o presente.
Está oculto do Placar de Líderes?
 exclude_from_leaderboard boolean

Está oculto do Placar de Líderes?
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o presente pelo banco de dados externo.
Mensagem de tributo
 honor_message string

Uma mensagem para um tributo de presente.
Prefixo de tributo
 honor_prefix string

Um prefixo para um tributo de presente. As opções disponíveis são in_honor_of, in_memory_of, in_support_of
Anônimo?
 is_anonymous boolean

Indica que o desejo do doador é ser anônimo para outros doadores para este presente.
Observação
 note string

O texto da anotação.
Outro Nome do Fundo
 other_fund_name string

Quando o doador seleciona um fundo marcado como is_other_fund, ele adiciona um nome de fundo personalizado para atribuir o presente.
Página de Doação
 id integer

ID gerada pelo sistema para identificar exclusivamente uma página de doação.
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente um registro.
Quantidade
 amount True string

A quantidade da divisão do presente.
Fundo
 id True integer

ID gerada pelo sistema para identificar exclusivamente um fundo.

Retornos

Presente

Corpo
v1.GivingApi.GiftRead

Atualizar um registro

ID da operação:
UpdateRecord

Atualiza um registro.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Registro
 id True integer

ID gerada pelo sistema para identificar exclusivamente um registro.
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o registro pelo banco de dados externo. por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
ID de pesquisa de banco de dados externo
 external_database_lookup_id string

Uma ID de pesquisa personalizada definida pelo usuário para o registro no banco de dados externo. Por exemplo, ID constituinte
Primeiro Nome
 first_name string

Nome do registro.
Apelido
 last_name string

Sobrenome do registro.

Retornos

registro

Corpo
v1.RecordApi.RecordRead

Atualizar uma pessoa de contato

ID da operação:
UpdateEventContactPerson

Atualiza uma pessoa de contato em um evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
 id True integer

ID gerada pelo sistema para identificar exclusivamente um evento.
ID da pessoa de contato do evento
 person_id True integer

ID gerada pelo sistema para identificar exclusivamente uma pessoa de contato em um evento.
Email
 email email

Email da pessoa de contato
Nome
 name string

Nome da pessoa de contato
Número de Telefone
 phone_number string

Número de telefone da pessoa de contato

Retornos

Contate a pessoa de um evento

Corpo
v1.EventApi.ContactPersonRead

Criar um endereço de email para um registro

ID da operação:
CreateRecordEmailAddress

Cria um novo endereço de email para um registro.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Registro
 record_id True integer

ID gerada pelo sistema para identificar exclusivamente um registro.
Endereço
 address email

O endereço de email
Usar para logon?
 is_login_email boolean

Indica se o usuário tem permissão para fazer logon na Plataforma usando esse endereço de email.
É primário?
 is_primary boolean

Um email primário é usado para enviar os emails automatizados disparados pelo Sistema. Ele também é usado para enviar o email em massa para o perfil. É obrigatório que apenas um email seja definido como primário.
Source
 source string

A origem indica como o email é adicionado ao banco de dados.
Situação
 status string

Status do endereço de email
Tipo
 type string

O tipo do email

Retornos

Endereço eletrônico

Corpo
v1.RecordApi.EmailAddressRead

Criar um evento

ID da operação:
CreateEvent

Cria um novo evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Description
 description string

Descrição do evento
Hora de Término
 end_datetime string

Hora de término do evento
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o registro pelo banco de dados externo. por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
URL de Registro Externo
 external_registration_url string

A URL de registro do evento em um site externo
Nome
 name True string

Nome do evento
Hora de Início
 start_datetime string

Hora de início do evento
Timezone
 timezone string

Fuso horário do evento
Nome
 display_name string

Cidade, Estado, País do Local

Retornos

Event

Corpo
v1.EventApi.EventRead

Criar um fundo

ID da operação:
CreateFund

Cria um novo fundo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o fundo pelo banco de dados externo. por exemplo, ID de registro do sistema para Raiser Edge NXT, ID do objeto para Salesforce
O fundo padrão é?
 is_default boolean

Indica associar todas as divisões a esse fundo se nenhum outro fundo for definido na Página de Doação.
Outro fundo é?
 is_other_fund boolean

Indica que os doadores desse fundo deram o nome do fundo personalizado.
Nome do fundo
 name True string

Nome do fundo

Retornos

O fundo associado à divisão do presente.

Fundo
v1.GivingApi.FundRead

Criar um ponto de toque

ID da operação:
createTouchpointCustomObject

Envie um novo ponto de toque personalizado para o Almabase.

Parâmetros

Nome Chave Obrigatório Tipo Description
Programa
 touchpoint_program True integer

Filtra os tipos por programas touchpoint.
Email
 email email

ID de email usada para a atividade.
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente um registro.
Gravado em
 recorded_at True date-time

O carimbo de data/hora da atividade.
Tipo
 id True integer

Retornos

Corpo do ponto de toque para criar um novo ponto de toque

Corpo
v1.AlmasightsApi.TouchpointCustomObjectAdd

Criar um presente

ID da operação:
CreateGift

Cria um novo presente.

Parâmetros

Nome Chave Obrigatório Tipo Description
Valor do Presente
 amount True string

A quantidade de presentes com duas decimais.
Número do Lote
 batch_number string

O número do lote do presente.
Data do Presente
 completed_at True date-time

A data em que o status do presente é marcado como concluído.
Moeda
 currency True integer

Moeda usada pelo doador para o presente.
Endereço do doador: Linha 1
 donor_address_line1 string

A linha de endereço 1 usada pelo doador para o presente.
Endereço do doador: Linha 2
 donor_address_line2 string

O endereço da linha 2 usado pelo doador para o presente.
Nome: Cidade, Estado, País
 name string

A cidade do doador. Formato: Nome da Cidade, Nome do Estado Curto, Nome do País Curto
Email do doador
 donor_email True email

ID de email usada pelo doador para o presente.
Nome do doador
 donor_name True string

Nome completo do doador.
Número de telefone do doador
 donor_phone_number string

Número de telefone usado pelo doador para o presente.
Endereço do doador: Cep
 donor_zip_code string

O cep do endereço usado pelo doador para o presente.
Está oculto do Placar de Líderes?
 exclude_from_leaderboard boolean

Está oculto do Placar de Líderes?
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o presente pelo banco de dados externo.
Mensagem de tributo
 honor_message string

Uma mensagem para um tributo de presente.
Prefixo de tributo
 honor_prefix string

Um prefixo para um tributo de presente. As opções disponíveis são in_honor_of, in_memory_of, in_support_of
Anônimo?
 is_anonymous boolean

Indica que o desejo do doador é ser anônimo para outros doadores para este presente.
Modo de Pagamento
 mode True string

Modo de Pagamento, online ou offline.
Observação
 note string

O texto da anotação.
Outro Nome do Fundo
 other_fund_name string

Quando o doador seleciona um fundo marcado como is_other_fund, ele adiciona um nome de fundo personalizado para atribuir o presente.
Página de Doação
 id integer

ID gerada pelo sistema para identificar exclusivamente uma página de doação.
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente um registro.
Quantidade
 amount True string

A quantidade da divisão do presente.
Fundo
 id True integer

ID gerada pelo sistema para identificar exclusivamente um fundo.
Situação
 status True string

Status do presente.

Retornos

Presente

Corpo
v1.GivingApi.GiftRead

Criar um registro

ID da operação:
CreateRecord

Cria um novo registro.

Parâmetros

Nome Chave Obrigatório Tipo Description
Linha 1
 line1 True string

Linha 1 do endereço
Linha 2
 line2 string

Linha 2 do endereço
Nome
 name string

Cidade, Estado, País da Localização
Privacidade
 privacy string

privacidade
Tipo
 type True string

Tipo do número
Cepcódigo
 zip_code string

Cepcódigo do endereço
Data de nascimento
 date_of_birth string

Data de nascimento.
Falecido
 deceased boolean

Falecido.
Endereço
 address email

O endereço de email
Usar para logon?
 is_login_email boolean

Indica se o usuário tem permissão para fazer logon na Plataforma usando esse endereço de email.
É primário?
 is_primary boolean

Um email primário é usado para enviar os emails automatizados disparados pelo Sistema. Ele também é usado para enviar o email em massa para o perfil. É obrigatório que apenas um email seja definido como primário.
Source
 source string

A origem indica como o email é adicionado ao banco de dados.
Situação
 status string

Status do endereço de email
Tipo
 type string

O tipo do email
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o registro pelo banco de dados externo. por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
ID de pesquisa de banco de dados externo
 external_database_lookup_id string

Uma ID de pesquisa personalizada definida pelo usuário para o registro no banco de dados externo. Por exemplo, ID constituinte
Primeiro Nome
 first_name True string

Nome do registro.
Apelido
 last_name True string

Sobrenome do registro.
Nome do Meio
 middle_name string

Nome do meio do registro.
Número
 number True string

Número
Privacidade
 privacy string

privacidade
Tipo
 type True string

Tipo do número

Retornos

registro

Corpo
v1.RecordApi.RecordRead

Enviar um formulário

ID da operação:
CreateFormEntry

Cria um novo envio de formulário para um formulário

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
 form_id True integer

ID gerada pelo sistema para identificar exclusivamente um formulário.
body
 body dynamic

Criar um novo envio de formulário

Retornos

Nome Caminho Tipo Description
ID de resposta
 id integer

ID gerada pelo sistema para identificar exclusivamente um envio de formulário.

Excluir um endereço de email de um registro

ID da operação:
DeleteRecordEmailAddress

Exclua um endereço de email de um registro.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Registro
 record_id True integer

ID gerada pelo sistema para identificar exclusivamente um registro.
ID
 email_id True integer

ID gerada pelo sistema para identificar exclusivamente um endereço de email de um registro.

Formulários de lista

ID da operação:
ListForms

Obtenha uma lista de formulários.

Parâmetros

Nome Chave Obrigatório Tipo Description
Fields
 fields array

A lista de campos semeados por vírgula na resposta.

Retornos

response
array of v1.FormApi.FormRead

Listar endereços de email de um registro

ID da operação:
ListRecordEmailAddresses

Retorna uma lista de endereços de email para um registro.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Registro
 record_id True integer

ID gerada pelo sistema para identificar exclusivamente um registro.
É primário?
 is_primary boolean

Pesquise emails primários.
Fields
 fields array

A lista de campos semeados por vírgula na resposta.
Tamanho da Página
 page_size integer

Representa o número de registros a serem retornados. O padrão é 10. O máximo é 50.
Número da Página
 page integer

Represente os números de página (deslocamento). Para uso com paginação.

Retornos

Nome Caminho Tipo Description
URL dos próximos resultados
 nextlink uri

URL para o próximo conjunto de páginas de resultados. Para uso com paginação.
URL de resultados anteriores
 previouslink uri

URL do conjunto anterior de resultados. Para uso com paginação.
Total de endereços de email
 total integer

Total de endereços de email para os filtros especificados
Endereço eletrônico
 value array of v1.RecordApi.EmailAddressRead

Lista de endereços de email de um registro retornado para os filtros especificados. Os resultados são paginados.

Listar eventos

ID da operação:
ListEvents

Retorna uma lista de todos os eventos.

Parâmetros

Nome Chave Obrigatório Tipo Description
Pesquisar por ID de banco de dados externo
 external_database_id string

Pesquise eventos por ID de banco de dados externo.
Fields
 fields array

A lista de campos semeados por vírgula na resposta.

Retornos

response
array of v1.EventApi.EventRead

Listar fundos

ID da operação:
ListFunds

Retorna uma lista de fundos

Parâmetros

Nome Chave Obrigatório Tipo Description
Fields
 fields array

A lista de campos semeados por vírgula na resposta.

Retornos

response
array of v1.GivingApi.FundRead

Listar pessoas de contato

ID da operação:
ListEventContactPersons

Retorna uma lista de todas as pessoas de contato em um evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
 id True integer

ID gerada pelo sistema para identificar exclusivamente um evento.

Retornos

response
array of v1.EventApi.ContactPersonRead

Listar presentes

ID da operação:
ListGifts

Retorna uma lista de presentes.

Parâmetros

Nome Chave Obrigatório Tipo Description
Situação
 status True string

Filtrar presentes com base no status.
Página de Doação
 campaign integer

ID gerada pelo sistema para identificar exclusivamente uma página de doação.
Filtrar por ID do grupo de presentes
 group_id uuid

ID gerada pelo sistema para identificar exclusivamente um grupo de presentes ou uma lista.
Deve ter um número de lote vazio?
 batch_number__isnull boolean

Filtrar presentes com base em um número de lote ou não.
Deve ter uma ID de banco de dados externa vazia?
 external_database_id__isnull boolean

Filtrar presentes com base em que eles já têm id de banco de dados externo ou não. OBSERVAÇÃO: Os Presentes que têm id de banco de dados externo já são enviados por push para o banco de dados externo.
Filtrar por ID de Banco de Dados Externo
 external_database_id string

Filtrar presentes com base na ID do banco de dados externo.
Filtrar por email do doador
 donor_email string

Filtrar presentes com base no endereço de email do doador
Pesquisar por
 search string

Pesquise presentes por nome ou endereço de email.
Fields
 fields array

A lista de campos semeados por vírgula na resposta.
Tamanho da Página
 page_size integer

Representa o número de registros a serem retornados. O padrão é 10. O máximo é 50.
Número da Página
 page integer

Represente os números de página (deslocamento). Para uso com paginação.
Ordem por
 ordering string

Defina a ordem dos presentes na resposta. Um prefixo "-" representa a ordem decrescente e a ausência do prefixo retornaria os resultados em ordem crescente.

Retornos

Nome Caminho Tipo Description
URL dos próximos resultados
 nextlink uri

URL para o próximo conjunto de páginas de resultados. Para uso com paginação.
URL de resultados anteriores
 previouslink uri

URL do conjunto anterior de resultados. Para uso com paginação.
Total de Presentes
 total integer

Total de presentes para os filtros especificados
Presentes
 value array of v1.GivingApi.GiftRead

Lista de presentes retornados para os filtros especificados. Os resultados são paginados.

Listar páginas de doação

ID da operação:
ListGivingPages

Retorna uma lista de páginas de doação.

Parâmetros

Nome Chave Obrigatório Tipo Description
Fields
 fields array

A lista de campos semeados por vírgula na resposta.

Retornos

response
array of v1.GivingApi.GivingPageRead

Listar registos

ID da operação:
ListRecords

Retorna uma lista de registros.

Parâmetros

Nome Chave Obrigatório Tipo Description
Pesquisar por nome
 search string

Pesquise registros por nome.
Pesquisar por endereço de email
 email_addresses__address string

Pesquise registros por endereço de email.
Pesquisar por ID de banco de dados externo
 external_database_id string

Pesquise registros por ID de banco de dados externo.
Fields
 fields array

A lista de campos semeados por vírgula na resposta.
Atualizado em ou após
 updated_at__gte date-time

Atualizado em ou após uma data.
Criado em ou após
 created_at__gte date-time

Criado em ou após uma data.
Tamanho da Página
 page_size integer

Representa o número de registros a serem retornados. O padrão é 10. O máximo é 50.
Número da Página
 page integer

Represente os números de página (deslocamento). Para uso com paginação.

Retornos

Nome Caminho Tipo Description
URL dos próximos resultados
 nextlink uri

URL para o próximo conjunto de páginas de resultados. Para uso com paginação.
URL de resultados anteriores
 previouslink uri

URL do conjunto anterior de resultados. Para uso com paginação.
Total de registros
 total integer

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

Lista de registros de um registro retornado para os filtros especificados.

Obter um endereço de email de um registro

ID da operação:
GetRecordEmailAddress

Retorna informações sobre um endereço de email de um registro.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Registro
 record_id True integer

ID gerada pelo sistema para identificar exclusivamente um registro.
ID
 email_id True integer

ID gerada pelo sistema para identificar exclusivamente um endereço de email de um registro.

Retornos

Endereço eletrônico

Corpo
v1.RecordApi.EmailAddressRead

Obter um envio de um formulário

ID da operação:
GetFormEntry

Retorna informações sobre um envio de formulário.

Parâmetros

Nome Chave Obrigatório Tipo Description
Formulário
 form_id True integer

ID gerada pelo sistema para identificar exclusivamente um formulário.
ID de resposta
 entry_id True string

ID gerada pelo sistema para identificar exclusivamente um envio de formulário.

Retornos

As saídas desta operação são dinâmicas.

Obter um evento

ID da operação:
GetEvent

Retorna informações sobre um evento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do evento
 id True integer

ID gerada pelo sistema para identificar exclusivamente um evento.
Fields
 fields array

A lista de campos semeados por vírgula na resposta.

Retornos

Event

Corpo
v1.EventApi.EventRead

Obter um fundo

ID da operação:
GetFund

Retorna informações sobre um fundo.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do fundo
 id True integer

ID gerada pelo sistema para identificar exclusivamente um fundo.
Fields
 fields array

A lista de campos semeados por vírgula na resposta.

Retornos

O fundo associado à divisão do presente.

Fundo
v1.GivingApi.FundRead

Obter um presente

ID da operação:
GetGift

Retorna informações sobre um presente.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do presente
 id True integer

ID gerada pelo sistema para identificar exclusivamente um presente.
Fields
 fields array

A lista de campos semeados por vírgula na resposta.

Retornos

Presente

Corpo
v1.GivingApi.GiftRead

Obter um registro

ID da operação:
GetRecord

Retorna informações sobre um registro.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Registro
 id True integer

ID gerada pelo sistema para identificar exclusivamente um registro.
Fields
 fields array

A lista de campos semeados por vírgula na resposta.

Retornos

registro

Corpo
v1.RecordApi.RecordRead

Obter uma página de doação

ID da operação:
GetGivingPage

Retorna informações sobre uma página de doação.

Parâmetros

Nome Chave Obrigatório Tipo Description
Dando ID da página
 id True integer

ID gerada pelo sistema para identificar exclusivamente uma página de doação.
Fields
 fields array

A lista de campos semeados por vírgula na resposta.

Retornos

Página de Doação

Corpo
v1.GivingApi.GivingPageRead

Gatilhos

Quando um email é criado, atualizado ou excluído em um registro

Dispara quando um novo email é criado em um registro ou um email existente é atualizado ou excluído de um registro.
Quando um formulário é enviado ou um envio de formulário existente é atualizado

Dispara quando um formulário é enviado ou um envio de formulário existente é atualizado.
Quando um novo presente é bem-sucedido ou um pagamento de presente online falha

Dispara quando um novo presente é registrado com êxito em uma Página de Doação por um doador ou o pagamento a um presente falha.
Quando um registro é criado ou atualizado no Almabase

Dispara quando um novo registro é criado no Almabase ou um registro existente é atualizado.

Quando um email é criado, atualizado ou excluído em um registro

ID da operação:
EmailChangedWebhook

Dispara quando um novo email é criado em um registro ou um email existente é atualizado ou excluído de um registro.

Parâmetros

Nome Chave Obrigatório Tipo Description
When
 events True string

A lista de eventos para disparar o fluxo.

Retornos

Corpo
v1.RecordApi.EmailWebhookResponse

Quando um formulário é enviado ou um envio de formulário existente é atualizado

ID da operação:
FormEntryCreateOrUpdateWebhook

Dispara quando um formulário é enviado ou um envio de formulário existente é atualizado.

Parâmetros

Nome Chave Obrigatório Tipo Description
When
 events True string

A lista de eventos para disparar o fluxo.
Formulário
 object_id True integer

ID gerada pelo sistema para identificar exclusivamente um formulário.

Retornos

As saídas desta operação são dinâmicas.

Quando um novo presente é bem-sucedido ou um pagamento de presente online falha

ID da operação:
GiftSucceededOrFailedWebhook

Dispara quando um novo presente é registrado com êxito em uma Página de Doação por um doador ou o pagamento a um presente falha.

Parâmetros

Nome Chave Obrigatório Tipo Description
When
 events True string

A lista de eventos para disparar o fluxo.
Página de Doação
 object_id integer

ID gerada pelo sistema para identificar exclusivamente uma página de doação.

Retornos

Corpo
v1.GivingApi.GiftWebhookResponse

Quando um registro é criado ou atualizado no Almabase

ID da operação:
RecordChangedWebhook

Dispara quando um novo registro é criado no Almabase ou um registro existente é atualizado.

Parâmetros

Nome Chave Obrigatório Tipo Description
When
 events True string

A lista de eventos para disparar o fluxo.

Retornos

Corpo
v1.RecordApi.RecordWebhookResponse

Definições

v1. FormApi.FormRead

Formulário

Nome Caminho Tipo Description
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente um formulário.
Nome do Formulário
 title string

O nome do formulário

v1. GivingApi.GiftWebhookRecordRead

Registro

Nome Caminho Tipo Description
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o registro pelo banco de dados externo. por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
Primeiro Nome
 first_name string

Nome do registro mapeado
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente um registro.
O doador está registrado no Almabase?
 is_registered boolean

Indicar se o registro mapeado ou o doador registrado no Almabase
Apelido
 last_name string

Sobrenome do registro mapeado

v1. GivingApi.GiftWebhookResponse

Nome Caminho Tipo Description
Quantidade
 data.amount string

A quantidade de presentes com duas decimais.
Date
 data.completed_at date-time

A data em que o status do presente é marcado como concluído.
Email do doador
 data.email email

ID de email usada pelo doador para o presente.
ID do banco de dados externo
 data.external_database_id string

Uma ID exclusiva atribuída pelo sistema para o presente pelo banco de dados externo.
ID
 data.id integer

ID gerada pelo sistema para identificar exclusivamente um presente.
O novo email é?
 data.is_email_new boolean

Indica se o email fornecido pelo doador já existe nos registros do Almabase.
esquema
 data.mapped_profile.schema v1.GivingApi.GiftWebhookRecordRead

Registro
Mode
 data.mode string

Modo do presente.
Nome do doador
 data.name string

Nome completo do doador.
ID
 data.page.id integer

ID gerada pelo sistema para identificar exclusivamente uma página de doação.
Dando nome à página
 data.page.name string

Nome da página de doação associada
Situação
 data.status string

Status do presente.
Evento disparado em
 time string

A hora do evento.
Tipo de evento
 type string

O tipo de evento.

v1. GivingApi.LocationRead

A cidade usada pelo doador para o presente.

Nome Caminho Tipo Description
City
 city string

A cidade do doador
Nome Curto da Cidade
 city_short_name string

A breve representação da Cidade, por exemplo, SF
Latitude
 coordinates.latitude string

A latitude do local
Longitude
 coordinates.longitude string

A longitude do local
País
 country string

O país do doador
Nome curto do país
 country_short_name string

A breve representação do país, por exemplo, EUA
Google Place Id
 gpid string

A ID do local obtida do Google
Cidade, Estado, País
 name string

A cidade do doador. Formato: Nome da Cidade, Nome do Estado Curto, Nome do País Curto
Estado
 state string

O estado do doador
Nome curto de estado
 state_short_name string

A breve representação do estado, por exemplo, AC

v1. GivingApi.FormFieldRead

Campo formulário

Nome Caminho Tipo Description
Value
 display_value string

O valor formatado inserido pelos respondentes. Por exemplo, o nome do upload de arquivo.
Nome do campo Pergunta/Formulário
 label string

O nome do campo de pergunta/formulário no formulário

v1. GivingApi.FundRead

O fundo associado à divisão do presente.

Nome Caminho Tipo Description
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o fundo pelo banco de dados externo. por exemplo, ID de registro do sistema para Raiser Edge NXT, ID do objeto para Salesforce
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente um fundo.
O fundo padrão é?
 is_default boolean

Indica associar todas as divisões a esse fundo se nenhum outro fundo for definido na Página de Doação.
Outro fundo é?
 is_other_fund boolean

Indica que os doadores desse fundo deram o nome do fundo personalizado.
Nome
 name string

Nome do fundo

v1. GivingApi.GiftRead

Presente

Nome Caminho Tipo Description
Valor do Presente
 amount string

A quantidade de presentes com duas decimais.
Número do Lote
 batch_number string

O número do lote do presente.
Data do Presente
 completed_at date-time

A data em que o status do presente é marcado como concluído.
Moeda
 currency integer

Moeda usada pelo doador para o presente.
Device
 device string

Identifique o dispositivo usado para fazer o presente, por exemplo, computador, celular ou tablet.
Endereço do doador: Linha 1
 donor_address_line1 string

A linha de endereço 1 usada pelo doador para o presente.
Endereço do doador: Linha 2
 donor_address_line2 string

O endereço da linha 2 usado pelo doador para o presente.
Endereço do doador: local
 donor_city_place v1.GivingApi.LocationRead

A cidade usada pelo doador para o presente.
Email do doador
 donor_email email

ID de email usada pelo doador para o presente.
Nome do doador
 donor_name string

Nome completo do doador.
Número de telefone do doador
 donor_phone_number string

Número de telefone usado pelo doador para o presente.
Endereço do doador: Cep
 donor_zip_code string

O cep do endereço usado pelo doador para o presente.
Está oculto do Placar de Líderes?
 exclude_from_leaderboard boolean

Está oculto do Placar de Líderes?
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o presente pelo banco de dados externo.
Mensagem de tributo
 honor_message string

Uma mensagem para um tributo de presente.
Prefixo de tributo
 honor_prefix string

Um prefixo para um tributo de presente. As opções disponíveis são in_honor_of, in_memory_of, in_support_of
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente um presente.
Influenciador
 influencer v1.GivingApi.InfluencerRead

O link de compartilhamento público e o link do painel privado
Anônimo?
 is_anonymous boolean

Indica que o desejo do doador é ser anônimo para outros doadores para este presente.
O doador cobriu os encargos do gateway de pagamento?
 is_donor_covered_charges boolean

Indica se o doador optou por cobrir os encargos do gateway de pagamento ao fazer o presente?
O email é adicionado a um registro no Almabase?
 is_email_added_to_profile boolean

Indica se o email fornecido pelo doador é adicionado no registro almabase (independentemente de is_email_new status)
O novo email é?
 is_email_new boolean

Indica se o email fornecido pelo doador já existe nos registros do Almabase.
O mapeamento para um registro no Almabase é ignorado?
 is_profile_mapping_ignored boolean

Indica se o mapeamento de registro deve ser ignorado.
Modo de Pagamento
 mode string

Modo de Pagamento, online ou offline.
Observação
 note string

O texto da anotação.
Outro Nome do Fundo
 other_fund_name string

Quando o doador seleciona um fundo marcado como is_other_fund, ele adiciona um nome de fundo personalizado para atribuir o presente.
Página de Doação
 page v1.GivingApi.GivingPageAssociatedWithGift

A página de doação associada ao presente.
Fields
 post_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
ID de resposta
 post_payment_form_entry.id integer

ID gerada pelo sistema para identificar exclusivamente um envio de formulário.
Fields
 pre_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
ID de resposta
 pre_payment_form_entry.id integer

ID gerada pelo sistema para identificar exclusivamente um envio de formulário.
Registro Mapeado
 profile v1.GivingApi.RecordRead

Registro mapeado no Almabase
Link do referenciador
 referrer_link string

O link do site para identificar a fonte de como o doador visita. Por exemplo, Doador visitou a campanha De doação do Facebook, Google, etc.
Valor do reembolso
 refund_amount string

O valor reembolsado ao doador. Se todo o valor for reembolsado, o status do presente será reembolsado em vez de concluído.
Divide
 splits array of v1.GivingApi.GiftSplitRead

As divisões associadas ao presente.
Situação
 status string

Status do presente.
Transação online
 transaction v1.GivingApi.TransactionRead

A transação de pagamento online associada ao presente.
Campanha UTM
 utm_campaign string

Usado para análise de palavra-chave. utm_campaign identificar uma promoção de produto específica ou uma campanha estratégica. por exemplo, annual_fund_2020
Médio UTM
 utm_medium string

utm_medium identificar um meio, como email ou custo por clique. por exemplo, cpc
Origem UTM
 utm_source string

utm_source identificar um mecanismo de pesquisa, um nome de boletim informativo ou outra fonte. Por exemplo, Google

v1. GivingApi.GiftSplitRead

Divisão de Presentes

Nome Caminho Tipo Description
Quantidade
 amount string

A quantidade da divisão do presente.
Fundo
 fund v1.GivingApi.FundRead

O fundo associado à divisão do presente.
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente uma divisão de presentes.

v1. GivingApi.GivingPageAssociatedWithGift

A página de doação associada ao presente.

Nome Caminho Tipo Description
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente uma página de doação.
Nome
 name string

Nome da Página de Doação associada.

v1. GivingApi.GivingPageRead

Página de Doação

Nome Caminho Tipo Description
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente uma página de doação.
Nome
 name string

Nome da página de doação

v1. GivingApi.InfluencerRead

O link de compartilhamento público e o link do painel privado

Nome Caminho Tipo Description
Link do Painel do Influenciador Privado
 dashboard_url uri

O painel privado do doador para monitorar o número de visitas de página e presentes influenciados por eles
Link de Compartilhamento Público
 page_share_url uri

O link público de dar página/campanha do doador para acompanhar a influência nas visitas à Página de Doação e aos presentes.

v1. GivingApi.PaymentAccountRead

A conta de pagamento associada à transação, por exemplo, BBMS, Stripe, PayPal etc.

Nome Caminho Tipo Description
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente uma conta de pagamento.
Nome
 name string

O nome da conta de pagamento.
Gateway
 type string

O nome do gateway de pagamento.

v1. GivingApi.RecordRead

Registro mapeado no Almabase

Nome Caminho Tipo Description
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o registro pelo banco de dados externo. por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
Primeiro Nome
 first_name string

Nome do registro mapeado
Nome Completo
 formatted_name string

Nome completo do registro mapeado
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente um registro.
O doador está registrado no Almabase?
 is_registered boolean

Indicar se o registro mapeado ou o doador registrado no Almabase
Apelido
 last_name string

Sobrenome do registro mapeado
URL da imagem
 present_picture uri

A URL da imagem de registro
Link
 profile_url uri

O link de registro no Almabase

v1. GivingApi.TransactionRead

A transação de pagamento online associada ao presente.

Nome Caminho Tipo Description
Conta de pagamento
 account v1.GivingApi.PaymentAccountRead

A conta de pagamento associada à transação, por exemplo, BBMS, Stripe, PayPal etc.
Criado em
 created_at date-time

O tempo de criação dessa transação.
Motivo da falha
 failure_reason string

O motivo da falha de transação retornado pelo gateway de pagamento.
ID
 id uuid

ID gerada pelo sistema para identificar exclusivamente uma transação.
Situação
 status integer

Status da transação. - 1 (Não processado) - 2 (bem-sucedido) - 3 (com falha) - 4 (pendente) - 5 (erro) OBSERVAÇÃO: estes status estão associados ao status da transação pelo Gateway de Pagamento
ID de referência do Gateway de Pagamento
 transaction_id string

A ID exclusiva gerada pelo gateway de pagamento para identificar a transação. Por exemplo, a ID da transação do BBMS (Blackbaud Merchant Services) ou a ID de cobrança do Stripe, PayPal ID da transação

v1. AlmasightsApi.RecordAddOrEdit

Gravar no Almabase.

Nome Caminho Tipo Description
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente um registro.

v1. AlmasightsApi.TouchpointCustomObjectAdd

Corpo do ponto de toque para criar um novo ponto de toque

Nome Caminho Tipo Description
Email
 email email

ID de email usada para a atividade.
Registro
 mapped_profile v1.AlmasightsApi.RecordAddOrEdit

Gravar no Almabase.
Gravado em
 recorded_at date-time

O carimbo de data/hora da atividade.
Tipo
 touchpoint_type.id integer

v1. RecordApi.LocationRead

Local do endereço

Nome Caminho Tipo Description
City
 city string

Nome da cidade do local
País
 country string

Nome do país do local
Latitude
 latitude double

A latitude do local
Longitude
 longitude double

A longitude do local
Estado
 state string

Nome do estado do local

v1. RecordApi.AddressRead

Endereço

Nome Caminho Tipo Description
Linha 1
 line1 string

Linha 1 do endereço
Linha2
 line2 string

Linha 2 do endereço
esquema
 location.schema v1.RecordApi.LocationRead

Local do endereço
Cepcódigo
 zipcode string

Cepcódigo do endereço

v1. RecordApi.EmailWebhookRecordRead

Registro

Nome Caminho Tipo Description
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o registro pelo banco de dados externo. por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
Primeiro Nome
 first_name string

Nome do registro mapeado
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente um registro.
O registro está registrado no Almabase?
 is_registered boolean

Indicar se o registro mapeado registrado no Almabase
Apelido
 last_name string

Sobrenome do registro mapeado

v1. RecordApi.EmailWebhookResponse

Nome Caminho Tipo Description
Endereço eletrônico
 data.address email

Endereço de email.
ID
 data.id integer

ID gerada pelo sistema para identificar exclusivamente um email.
É Primário
 data.is_primary boolean

Indica se o email é primário ou não.
esquema
 data.profile.schema v1.RecordApi.EmailWebhookRecordRead

Registro
Tipo de email
 data.type string

Tipo do endereço de email (primário, pessoal, trabalho etc.
Evento disparado em
 time string

A hora do evento.
Tipo de evento
 type string

O tipo de evento.

v1. RecordApi.RecordWebhookResponse

Nome Caminho Tipo Description
Afiliações
 data.affiliations array of string
Ano de Classe
 data.class_year string

Ano de classe do registro
Endereço eletrônico
 data.email email

Endereço de email.
ID do banco de dados externo
 data.external_database_id string

Uma ID exclusiva atribuída pelo sistema para o registro pelo banco de dados externo. por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
Primeiro Nome
 data.first_name string

Nome do registro mapeado
esquema
 data.home_address.schema v1.RecordApi.AddressRead

Endereço
ID
 data.id integer

ID gerada pelo sistema para identificar exclusivamente um registro.
Apelido
 data.last_name string

Sobrenome do registro mapeado
Data de expiração da associação
 data.membership_expiry_date date-time

Data de expiração da associação do registro
Nome do tipo de associação
 data.membership_type_name string

Nome do tipo de associação do registro
Número do Celular
 data.mobile_number string

Número de celular do registro
esquema
 data.office_address.schema v1.RecordApi.AddressRead

Endereço
Número de telefone do Office
 data.office_phone_number string

Número de telefone do Office do registro
Número de telefone de residência
 data.residence_phone_number string

Número de telefone da residência do registro
Evento disparado em
 time string

A hora do evento.
Tipo de evento
 type string

O tipo de evento.

v1. RecordApi.EmailAddressRead

Endereço eletrônico

Nome Caminho Tipo Description
Endereço
 address email

O endereço de email
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente um endereço de email de um registro.
Está noivo?
 is_engaged boolean

Indica se um email em massa está clicado ou aberto ou se o usuário responde a um email
Usar para logon?
 is_login_email boolean

Indica se o usuário tem permissão para fazer logon na Plataforma usando esse endereço de email.
É primário?
 is_primary boolean

Um email primário é usado para enviar os emails automatizados disparados pelo Sistema. Ele também é usado para enviar o email em massa para o registro. É obrigatório que apenas um email seja definido como primário.
É verificado pelo usuário?
 is_verified boolean

Indique se o usuário verificou que é o proprietário do email.
fonte
 source string

A origem indica como o email é adicionado ao banco de dados.
status
 status string
Tipo
 type string

O tipo do email

v1. RecordApi.RecordRead

registro

Nome Caminho Tipo Description
Emails
 email_addresses array of v1.RecordApi.EmailAddressRead

Lista de endereços de email de um perfil
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o registro pelo banco de dados externo. por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
Primeiro Nome
 first_name string

Nome do registro.
Nome Completo
 formatted_name string

Nome completo do registro.
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente um registro.
Está registrado no Almabase?
 is_registered boolean

Indicar se o registro ou doador registrado no Almabase
Apelido
 last_name string

Sobrenome do registro.
URL da imagem
 present_picture uri

A URL da imagem de registro
Link
 record_url uri

O link de registro no Almabase

v1. EventApi.ContactPersonRead

Contate a pessoa de um evento

Nome Caminho Tipo Description
Email
 email email

Email da pessoa de contato
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente uma pessoa de contato.
Nome
 name string

Nome da pessoa de contato
Número de Telefone
 phone_number string

Número de telefone da pessoa de contato

v1. EventApi.EventRead

Event

Nome Caminho Tipo Description
Description
 description string

Descrição do evento
Hora de Término
 end_datetime string

Hora de término do evento
ID do banco de dados externo
 external_database_id string

Uma ID exclusiva atribuída pelo sistema para o registro pelo banco de dados externo. por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
URL de Registro Externo
 external_registration_url string

A URL de registro do evento em um site externo
ID
 id integer

ID gerada pelo sistema para identificar exclusivamente um evento.
Nome
 name string

Nome do evento
Hora de Início
 start_datetime string

Hora de início do evento
Timezone
 timezone string

Fuso horário do evento