Partilhar via

Almabase (Pré-visualização)

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 envolvimento dos doadores e hospedar comunidades on-line envolventes.

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

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Suporte Almabase
URL https://docs.almabase.com
Email help@almabase.com
Metadados do conector
Editora Almabase, Inc.
Sítio Web https://almabase.com
Política de privacidade https://www.almabase.com/ecloud-privacy-policy
Categorias Vendas e CRM; Produtividade

A Almabase fornece ferramentas de software e estratégias para instituições de ensino construírem programas centrados em ex-alunos que transformam ex-alunos não engajados em apoiadores para toda a vida.

Este conector é construído com base em APIs ou Webhooks do Almabase e fornece operações para ajudar a gerenciar entidades encontradas no Almabase, incluindo:

  • Record (Constituintes)
  • Presentes
  • Events
  • Pontos de contato de engajamento
  • Forms
  • Fundos
  • Dando páginas
  • Campanhas de Angariação de Fundos Peer to Peer
  • e mais...

Pré-requisitos

Para usar este conector,

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

Como obter credenciais

  • Faça login no seu Portal de Administração fornecido pela Almabase.
  • Navegue até API's & Tokens em Settings.
  • Clique em Add Auth Token, preencha o description, e defina o token expiry date & time.
  • Anote o Workflow Access Token (clique no token para copiar na área de transferência).
  • Use o Workflow Access Token ao criar a nova conexão no Power Automate.

Introdução ao conector

Casos de uso comuns

  • Quando um presente é feito, envie uma mensagem personalizada ou recibo de presente.
  • Quando uma atividade de interação é gravada no Slack, no Gmail ou em qualquer outra mídia social, adicione a atividade de interação ao Engagement Studio no Almabase usando Create Custom Touchpoint a ação.
  • Quando um novo endereço de e-mail for encontrado (ex-alunos perdidos) em um Presente, em um registro de evento ou em um envio de formulário, adicione esse endereço de e-mail a um registro no Almabase ou a um Constituinte no Raiser's Edge ou a 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 bidirecional entre o Almabase e o Salesforce.

Problemas conhecidos e limitações

  • Os gatilhos de presente funcionam apenas quando o pagamento on-line é feito no Almabase. Presentes adicionados manualmente não acionariam os fluxos.

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:
Predefinição 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.

Esta conexão não é compartilhável. Se o aplicativo avançado 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 (de caracteres) Especifique o URL do seu domínio Almabase, por exemplo: https://your.domain.com Verdade
Chave de API securestring A chave de API do usuário Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Adicionar uma pessoa de contacto

Adiciona uma pessoa de contato a um evento.
Atualizar um endereço de e-mail de um registro

Atualiza os campos do endereço de e-mail de um registro
Atualizar um evento

Atualiza um evento.
Atualizar um fundo

Atualiza um fundo.
Atualizar um presente

Atualiza um presente
Atualizar um registo

Atualiza um registro.
Atualizar uma pessoa de contacto

Atualiza uma pessoa de contato em um evento.
Criar um endereço de e-mail para um registo

Cria um novo endereço de e-mail para um registro.
Criar um evento

Cria um novo evento.
Criar um fundo

Cria um novo fundo.
Criar um ponto de contato

Envie um novo ponto de contato personalizado para a Almabase.
Criar um presente

Cria um novo presente.
Criar um registo

Cria um novo registro.
Enviar um formulário

Cria um novo envio de formulário para um formulário
Excluir um endereço de e-mail de um registro

Excluir um endereço de e-mail de um registro.
Listar endereços de e-mail de um registro

Retorna uma lista de endereços de e-mail para um registro.
Listar Eventos

Retorna uma lista de todos os eventos.
Listar formulários

Obtenha uma lista de formulários.
Listar fundos

Devolve uma lista de fundos
Listar Pessoas de Contacto

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

Devolve uma lista de presentes.
Listar páginas que dão

Retorna uma lista de páginas de oferta.
Listar registos

Retorna uma lista de registros.
Obter o envio de um formulário

Retorna informações sobre um envio de formulário.
Obter um endereço de e-mail de um registo

Retorna informações sobre um endereço de e-mail de um registro.
Obter um fundo

Devolve informações sobre um fundo.
Obter um registo

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

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

Retorna informações sobre um evento.
Receba um presente

Retorna informações sobre um presente.

Adicionar uma pessoa de contacto

ID da Operação:
AddEventContactPerson

Adiciona uma pessoa de contato a um evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
 id True integer

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

E-mail da pessoa de contacto
Nome
 name string

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

Número de telefone da pessoa de contacto

Devoluções

Pessoa de contacto de um evento

Body
v1.EventApi.ContactPersonRead

Atualizar um endereço de e-mail de um registro

ID da Operação:
UpdateRecordEmailAddress

Atualiza os campos do endereço de e-mail de um registro

Parâmetros

Name Chave Necessário Tipo Description
ID do Registo
 record_id True integer

ID gerado pelo sistema para identificar exclusivamente um registro.
ID do endereço de e-mail
 email_id True integer

ID gerado pelo sistema para identificar exclusivamente um endereço de e-mail de um registro.
Uso para login?
 is_login_email boolean

Indica se o utilizador tem permissão para iniciar sessão na Plataforma utilizando este endereço de e-mail.
É primário?
 is_primary boolean

Um e-mail principal é usado para enviar os e-mails automatizados acionados pelo Sistema. Ele também é usado para enviar o e-mail em massa para o perfil. É obrigatório que apenas um e-mail seja definido como principal.
Situação
 status string

Status do endereço de e-mail
Tipo
 type string

O tipo de e-mail

Devoluções

Endereço de E-mail

Body
v1.RecordApi.EmailAddressRead

Atualizar um evento

ID da Operação:
UpdateEvent

Atualiza um evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
 id True integer

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

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

Hora de fim do evento
ID do banco de dados externo
 external_database_id string

Um sistema atribuído ID exclusivo 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 Registo Externo
 external_registration_url string

O url de inscrição 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

Devoluções

Event

Body
v1.EventApi.EventRead

Atualizar um fundo

ID da Operação:
UpdateFund

Atualiza um fundo.

Parâmetros

Name Chave Necessário Tipo Description
ID do Fundo
 id True integer

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

Um sistema atribuído ID único para o fundo pela base de dados externa. Por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de objeto para Salesforce
É fundo de inadimplência?
 is_default boolean

Indica associar todas as divisões a este fundo se nenhum outro fundo estiver definido na Página de Doação.
É outro fundo?
 is_other_fund boolean

Indica que os doadores deste fundo deram nome personalizado ao fundo.
Nome do Fundo
 name True string

Nome do fundo

Devoluções

O fundo associado ao presente dividiu-se.

Fundo
v1.GivingApi.FundRead

Atualizar um presente

ID da Operação:
UpdateGift

Atualiza um presente

Parâmetros

Name Chave Necessário Tipo Description
ID de presente
 id True integer

ID gerado 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

A linha de endereço 2 usada 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 dador
 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 na Tabela de Classificação?
 exclude_from_leaderboard boolean

Está oculto na Tabela de Classificação?
ID do banco de dados externo
 external_database_id string

Um sistema atribuído ID exclusivo para o presente pelo banco de dados externo.
Mensagem de Homenagem
 honor_message string

Uma mensagem para uma homenagem de presente.
Prefixo do 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 o desejo do doador ser anônimo para outros doadores para esta doação.
Observação
 note string

O texto da nota.
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 gerado pelo sistema para identificar exclusivamente uma página de oferta.
ID
 id integer

ID gerado pelo sistema para identificar exclusivamente um registro.
Montante
 amount True string

O valor do presente dividido.
Fundo
 id True integer

ID gerado pelo sistema para identificar exclusivamente um fundo.

Devoluções

Presente

Body
v1.GivingApi.GiftRead

Atualizar um registo

ID da Operação:
UpdateRecord

Atualiza um registro.

Parâmetros

Name Chave Necessário Tipo Description
ID do Registo
 id True integer

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

Um sistema atribuído ID exclusivo 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

Um ID de pesquisa personalizado definido pelo usuário para o registro no banco de dados externo. por exemplo, identificação do constituinte
Nome Próprio
 first_name string

Nome próprio do registo.
Apelido
 last_name string

Apelido do registo.

Devoluções

registo

Body
v1.RecordApi.RecordRead

Atualizar uma pessoa de contacto

ID da Operação:
UpdateEventContactPerson

Atualiza uma pessoa de contato em um evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
 id True integer

ID gerado pelo sistema para identificar exclusivamente um evento.
ID da Pessoa de Contacto do Evento
 person_id True integer

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

E-mail da pessoa de contacto
Nome
 name string

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

Número de telefone da pessoa de contacto

Devoluções

Pessoa de contacto de um evento

Body
v1.EventApi.ContactPersonRead

Criar um endereço de e-mail para um registo

ID da Operação:
CreateRecordEmailAddress

Cria um novo endereço de e-mail para um registro.

Parâmetros

Name Chave Necessário Tipo Description
ID do Registo
 record_id True integer

ID gerado pelo sistema para identificar exclusivamente um registro.
Address
 address email

O endereço de e-mail
Uso para login?
 is_login_email boolean

Indica se o utilizador tem permissão para iniciar sessão na Plataforma utilizando este endereço de e-mail.
É primário?
 is_primary boolean

Um e-mail principal é usado para enviar os e-mails automatizados acionados pelo Sistema. Ele também é usado para enviar o e-mail em massa para o perfil. É obrigatório que apenas um e-mail seja definido como principal.
Fonte
 source string

A fonte indica como o e-mail é adicionado ao banco de dados.
Situação
 status string

Status do endereço de e-mail
Tipo
 type string

O tipo de e-mail

Devoluções

Endereço de E-mail

Body
v1.RecordApi.EmailAddressRead

Criar um evento

ID da Operação:
CreateEvent

Cria um novo evento.

Parâmetros

Name Chave Necessário Tipo Description
Description
 description string

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

Hora de fim do evento
ID do banco de dados externo
 external_database_id string

Um sistema atribuído ID exclusivo 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 Registo Externo
 external_registration_url string

O url de inscrição 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

Devoluções

Event

Body
v1.EventApi.EventRead

Criar um fundo

ID da Operação:
CreateFund

Cria um novo fundo.

Parâmetros

Name Chave Necessário Tipo Description
ID do banco de dados externo
 external_database_id string

Um sistema atribuído ID único para o fundo pela base de dados externa. Por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de objeto para Salesforce
É fundo de inadimplência?
 is_default boolean

Indica associar todas as divisões a este fundo se nenhum outro fundo estiver definido na Página de Doação.
É outro fundo?
 is_other_fund boolean

Indica que os doadores deste fundo deram nome personalizado ao fundo.
Nome do Fundo
 name True string

Nome do fundo

Devoluções

O fundo associado ao presente dividiu-se.

Fundo
v1.GivingApi.FundRead

Criar um ponto de contato

ID da Operação:
createTouchpointCustomObject

Envie um novo ponto de contato personalizado para a Almabase.

Parâmetros

Name Chave Necessário Tipo Description
Programa
 touchpoint_program True integer

Filtra os tipos por programas de ponto de contato.
Email
 email email

ID de e-mail usado para a atividade.
ID
 id integer

ID gerado 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

Devoluções

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

Body
v1.AlmasightsApi.TouchpointCustomObjectAdd

Criar um presente

ID da Operação:
CreateGift

Cria um novo presente.

Parâmetros

Name Chave Necessário Tipo Description
Valor do presente
 amount True string

O valor do presente com duas casas 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 utilizada pelo doador para a doação.
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

A linha de endereço 2 usada 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
E-mail do doador
 donor_email True email

ID de e-mail usado pelo doador para o presente.
Nome do dador
 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 na Tabela de Classificação?
 exclude_from_leaderboard boolean

Está oculto na Tabela de Classificação?
ID do banco de dados externo
 external_database_id string

Um sistema atribuído ID exclusivo para o presente pelo banco de dados externo.
Mensagem de Homenagem
 honor_message string

Uma mensagem para uma homenagem de presente.
Prefixo do 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 o desejo do doador ser anônimo para outros doadores para esta doação.
Modo de Pagamento
 mode True string

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

O texto da nota.
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 gerado pelo sistema para identificar exclusivamente uma página de oferta.
ID
 id integer

ID gerado pelo sistema para identificar exclusivamente um registro.
Montante
 amount True string

O valor do presente dividido.
Fundo
 id True integer

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

Estatuto da dádiva.

Devoluções

Presente

Body
v1.GivingApi.GiftRead

Criar um registo

ID da Operação:
CreateRecord

Cria um novo registro.

Parâmetros

Name Chave Necessá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
Código postal
 zip_code string

CEP do Endereço
Data de Nascimento
 date_of_birth string

Data de nascimento.
Falecido
 deceased boolean

Falecido.
Address
 address email

O endereço de e-mail
Uso para login?
 is_login_email boolean

Indica se o utilizador tem permissão para iniciar sessão na Plataforma utilizando este endereço de e-mail.
É primário?
 is_primary boolean

Um e-mail principal é usado para enviar os e-mails automatizados acionados pelo Sistema. Ele também é usado para enviar o e-mail em massa para o perfil. É obrigatório que apenas um e-mail seja definido como principal.
Fonte
 source string

A fonte indica como o e-mail é adicionado ao banco de dados.
Situação
 status string

Status do endereço de e-mail
Tipo
 type string

O tipo de e-mail
ID do banco de dados externo
 external_database_id string

Um sistema atribuído ID exclusivo 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

Um ID de pesquisa personalizado definido pelo usuário para o registro no banco de dados externo. por exemplo, identificação do constituinte
Nome Próprio
 first_name True string

Nome próprio do registo.
Apelido
 last_name True string

Apelido do registo.
Segundo Nome
 middle_name string

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

Número
Privacidade
 privacy string

privacidade
Tipo
 type True string

Tipo do número

Devoluções

registo

Body
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

Name Chave Necessário Tipo Description
Formulário
 form_id True integer

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

Criar um novo envio de formulário

Devoluções

Name Caminho Tipo Description
ID da resposta
 id integer

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

Excluir um endereço de e-mail de um registro

ID da Operação:
DeleteRecordEmailAddress

Excluir um endereço de e-mail de um registro.

Parâmetros

Name Chave Necessário Tipo Description
ID do Registo
 record_id True integer

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

ID gerado pelo sistema para identificar exclusivamente um endereço de e-mail de um registro.

Listar endereços de e-mail de um registro

ID da Operação:
ListRecordEmailAddresses

Retorna uma lista de endereços de e-mail para um registro.

Parâmetros

Name Chave Necessário Tipo Description
ID do Registo
 record_id True integer

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

Pesquise o e-mail principal.
Campos
 fields array

A lista separada por vírgulas de campos 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

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

Devoluções

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

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

URL para o conjunto anterior de resultados. Para utilização com paginação.
Total de endereços de e-mail
 total integer

Total de endereços de e-mail para os filtros fornecidos
Endereço de E-mail
 value array of v1.RecordApi.EmailAddressRead

Lista de endereço de e-mail de um registro retornado para os filtros fornecidos. Os resultados são paginados.

Listar Eventos

ID da Operação:
ListEvents

Retorna uma lista de todos os eventos.

Parâmetros

Name Chave Necessário Tipo Description
Pesquisar por ID de banco de dados externo
 external_database_id string

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

A lista separada por vírgulas de campos na resposta.

Devoluções

response
array of v1.EventApi.EventRead

Listar formulários

ID da Operação:
ListForms

Obtenha uma lista de formulários.

Parâmetros

Name Chave Necessário Tipo Description
Campos
 fields array

A lista separada por vírgulas de campos na resposta.

Devoluções

response
array of v1.FormApi.FormRead

Listar fundos

ID da Operação:
ListFunds

Devolve uma lista de fundos

Parâmetros

Name Chave Necessário Tipo Description
Campos
 fields array

A lista separada por vírgulas de campos na resposta.

Devoluções

response
array of v1.GivingApi.FundRead

Listar Pessoas de Contacto

ID da Operação:
ListEventContactPersons

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

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
 id True integer

ID gerado pelo sistema para identificar exclusivamente um evento.

Devoluções

response
array of v1.EventApi.ContactPersonRead

Listar presentes

ID da Operação:
ListGifts

Devolve uma lista de presentes.

Parâmetros

Name Chave Necessário Tipo Description
Situação
 status True string

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

ID gerado pelo sistema para identificar exclusivamente uma página de oferta.
Filtrar por ID do Grupo de Presentes
 group_id uuid

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

Filtre os presentes com base no fato de eles terem um número de lote ou não.
Deve ter ID de banco de dados externo vazio?
 external_database_id__isnull boolean

Filtre presentes com base em que eles já têm ID de banco de dados externo ou não. NOTA: 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

Filtre presentes com base na ID do banco de dados externo.
Filtrar por e-mail do doador
 donor_email string

Filtrar presentes com base no endereço de e-mail do doador
Procurar por
 search string

Pesquise presentes por nome ou endereço de e-mail.
Campos
 fields array

A lista separada por vírgulas de campos 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

Representar os números de página (deslocamento). Para utilização com paginação.
Encomendar 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.

Devoluções

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

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

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

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

Lista de presentes devolvidos para os filtros fornecidos. Os resultados são paginados.

Listar páginas que dão

ID da Operação:
ListGivingPages

Retorna uma lista de páginas de oferta.

Parâmetros

Name Chave Necessário Tipo Description
Campos
 fields array

A lista separada por vírgulas de campos na resposta.

Devoluções

response
array of v1.GivingApi.GivingPageRead

Listar registos

ID da Operação:
ListRecords

Retorna uma lista de registros.

Parâmetros

Name Chave Necessário Tipo Description
Procurar por nome
 search string

Pesquise registos por nome.
Procurar por endereço de e-mail
 email_addresses__address string

Pesquise registos por endereço de e-mail.
Pesquisar por ID de banco de dados externo
 external_database_id string

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

A lista separada por vírgulas de campos 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

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

Devoluções

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

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

URL para o conjunto anterior de resultados. Para utilização com paginação.
Total de Registos
 total integer

Total de registos para os filtros fornecidos
Registos
 value array of v1.RecordApi.RecordRead

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

Obter o envio de um formulário

ID da Operação:
GetFormEntry

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

Parâmetros

Name Chave Necessário Tipo Description
Formulário
 form_id True integer

ID gerado pelo sistema para identificar exclusivamente um formulário.
ID da resposta
 entry_id True string

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

Devoluções

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

Obter um endereço de e-mail de um registo

ID da Operação:
GetRecordEmailAddress

Retorna informações sobre um endereço de e-mail de um registro.

Parâmetros

Name Chave Necessário Tipo Description
ID do Registo
 record_id True integer

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

ID gerado pelo sistema para identificar exclusivamente um endereço de e-mail de um registro.

Devoluções

Endereço de E-mail

Body
v1.RecordApi.EmailAddressRead

Obter um fundo

ID da Operação:
GetFund

Devolve informações sobre um fundo.

Parâmetros

Name Chave Necessário Tipo Description
ID do Fundo
 id True integer

ID gerado pelo sistema para identificar exclusivamente um fundo.
Campos
 fields array

A lista separada por vírgulas de campos na resposta.

Devoluções

O fundo associado ao presente dividiu-se.

Fundo
v1.GivingApi.FundRead

Obter um registo

ID da Operação:
GetRecord

Retorna informações sobre um registro.

Parâmetros

Name Chave Necessário Tipo Description
ID do Registo
 id True integer

ID gerado pelo sistema para identificar exclusivamente um registro.
Campos
 fields array

A lista separada por vírgulas de campos na resposta.

Devoluções

registo

Body
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

Name Chave Necessário Tipo Description
Dar ID de página
 id True integer

ID gerado pelo sistema para identificar exclusivamente uma página de oferta.
Campos
 fields array

A lista separada por vírgulas de campos na resposta.

Devoluções

Página de Doação

Body
v1.GivingApi.GivingPageRead

Receba um evento

ID da Operação:
GetEvent

Retorna informações sobre um evento.

Parâmetros

Name Chave Necessário Tipo Description
ID do Evento
 id True integer

ID gerado pelo sistema para identificar exclusivamente um evento.
Campos
 fields array

A lista separada por vírgulas de campos na resposta.

Devoluções

Event

Body
v1.EventApi.EventRead

Receba um presente

ID da Operação:
GetGift

Retorna informações sobre um presente.

Parâmetros

Name Chave Necessário Tipo Description
ID de presente
 id True integer

ID gerado pelo sistema para identificar exclusivamente um presente.
Campos
 fields array

A lista separada por vírgulas de campos na resposta.

Devoluções

Presente

Body
v1.GivingApi.GiftRead

Acionadores

Quando um e-mail é criado, atualizado ou excluído em um registro

Aciona quando um novo e-mail é criado em um registro ou um e-mail existente é atualizado ou excluído de um registro.
Quando um formulário é enviado ou um envio de formulário existente é atualizado

Aciona quando um formulário é enviado ou um envio de formulário existente é atualizado.
Quando um novo presente é bem-sucedido ou um pagamento de presente on-line é falhado

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

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

Quando um e-mail é criado, atualizado ou excluído em um registro

ID da Operação:
EmailChangedWebhook

Aciona quando um novo e-mail é criado em um registro ou um e-mail existente é atualizado ou excluído de um registro.

Parâmetros

Name Chave Necessário Tipo Description
Quando
 events True string

A lista de eventos para acionar o fluxo.

Devoluções

Body
v1.RecordApi.EmailWebhookResponse

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

ID da Operação:
FormEntryCreateOrUpdateWebhook

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

Parâmetros

Name Chave Necessário Tipo Description
Quando
 events True string

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

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

Devoluções

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

Quando um novo presente é bem-sucedido ou um pagamento de presente on-line é falhado

ID da Operação:
GiftSucceededOrFailedWebhook

Aciona quando um novo presente é registrado com sucesso em uma Página de Doação por um doador ou o pagamento a um presente é reprovado.

Parâmetros

Name Chave Necessário Tipo Description
Quando
 events True string

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

ID gerado pelo sistema para identificar exclusivamente uma página de oferta.

Devoluções

Body
v1.GivingApi.GiftWebhookResponse

Quando um registro é criado ou atualizado no Almabase

ID da Operação:
RecordChangedWebhook

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

Parâmetros

Name Chave Necessário Tipo Description
Quando
 events True string

A lista de eventos para acionar o fluxo.

Devoluções

Body
v1.RecordApi.RecordWebhookResponse

Definições

v1. FormApi.FormRead

Formulário

Name Caminho Tipo Description
ID
 id integer

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

O nome do formulário

v1. GivingApi.GiftWebhookRecordRead

Gravar / Registo

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

Um sistema atribuído ID exclusivo para o registro pelo banco de dados externo. Por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
Nome Próprio
 first_name string

Nome próprio do registo mapeado
ID
 id integer

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

Indicar se o registo mapeado ou o dador registado no Almabase
Apelido
 last_name string

Sobrenome do registro mapeado

v1. GivingApi.GiftWebhookResponse

Name Caminho Tipo Description
Montante
 data.amount string

O valor do presente com duas casas decimais.
Date
 data.completed_at date-time

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

ID de e-mail usado pelo doador para o presente.
ID do banco de dados externo
 data.external_database_id string

Um sistema atribuído ID exclusivo para o presente pelo banco de dados externo.
ID
 data.id integer

ID gerado pelo sistema para identificar exclusivamente um presente.
É novo e-mail?
 data.is_email_new boolean

Indica se o e-mail fornecido pelo doador já existe nos registros da Almabase.
esquema
 data.mapped_profile.schema v1.GivingApi.GiftWebhookRecordRead

Gravar / Registo
Mode
 data.mode string

Modo do presente.
Nome do dador
 data.name string

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

ID gerado pelo sistema para identificar exclusivamente uma página de oferta.
Dando nome de página
 data.page.name string

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

Estatuto da dádiva.
Evento acionado 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.

Name Caminho Tipo Description
City
 city string

A cidade do doador
Nome abreviado da cidade
 city_short_name string

A representação curta da cidade, por exemplo, SF
Latitude
 coordinates.latitude string

A latitude do local
Longitude
 coordinates.longitude string

A longitude do local
Country
 country string

País do dador
Nome abreviado do país
 country_short_name string

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

O id do lugar obtido 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 dador
Nome abreviado do estado
 state_short_name string

A representação curta do Estado, por exemplo, CA

v1. GivingApi.FormFieldRead

Campo de formulário

Name Caminho Tipo Description
Valor
 display_value string

O valor formatado inserido pelos respondentes. por exemplo, nome do carregamento do ficheiro.
Nome do campo Pergunta/Formulário
 label string

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

v1. GivingApi.FundRead

O fundo associado ao presente dividiu-se.

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

Um sistema atribuído ID único para o fundo pela base de dados externa. Por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de objeto para Salesforce
ID
 id integer

ID gerado pelo sistema para identificar exclusivamente um fundo.
É fundo de inadimplência?
 is_default boolean

Indica associar todas as divisões a este fundo se nenhum outro fundo estiver definido na Página de Doação.
É outro fundo?
 is_other_fund boolean

Indica que os doadores deste fundo deram nome personalizado ao fundo.
Nome
 name string

Nome do fundo

v1. GivingApi.GiftRead

Presente

Name Caminho Tipo Description
Valor do presente
 amount string

O valor do presente com duas casas 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 utilizada pelo doador para a doação.
Device
 device string

Identifique o dispositivo usado para fazer o presente, por exemplo, pc, 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

A linha de endereço 2 usada pelo doador para o presente.
Endereço do doador: Localização
 donor_city_place v1.GivingApi.LocationRead

A cidade usada pelo doador para o presente.
E-mail do doador
 donor_email email

ID de e-mail usado pelo doador para o presente.
Nome do dador
 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 na Tabela de Classificação?
 exclude_from_leaderboard boolean

Está oculto na Tabela de Classificação?
ID do banco de dados externo
 external_database_id string

Um sistema atribuído ID exclusivo para o presente pelo banco de dados externo.
Mensagem de Homenagem
 honor_message string

Uma mensagem para uma homenagem de presente.
Prefixo do 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 gerado 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 o desejo do doador ser anônimo para outros doadores para esta doação.
O doador cobriu as taxas do gateway de pagamento?
 is_donor_covered_charges boolean

Indica se o doador optou por cobrir os encargos do gateway de pagamento ao fazer esta doação?
O e-mail é adicionado a um registro no Almabase?
 is_email_added_to_profile boolean

Indica se o e-mail fornecido pelo doador é adicionado ao registro Almabase (independentemente do status is_email_new)
É novo e-mail?
 is_email_new boolean

Indica se o e-mail fornecido pelo doador já existe nos registros da 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 nota.
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.
Campos
 post_payment_form_entry.fields array of v1.GivingApi.FormFieldRead
ID da resposta
 post_payment_form_entry.id integer

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

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

Recorde mapeado em Almabase
Link de referência
 referrer_link string

O link do site para identificar a fonte de como o doador visita. Por exemplo, o doador visitou a campanha Giving a partir 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.
Divisões
 splits array of v1.GivingApi.GiftSplitRead

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

Estatuto da dádiva.
Transação Online
 transaction v1.GivingApi.TransactionRead

A transação de pagamento on-line associada ao presente.
Campanha UTM
 utm_campaign string

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

utm_medium identificar um meio como e-mail ou custo por clique. por exemplo, CPC
Fonte UTM
 utm_source string

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

v1. GivingApi.GiftSplitRead

Presente Split

Name Caminho Tipo Description
Montante
 amount string

O valor do presente dividido.
Fundo
 fund v1.GivingApi.FundRead

O fundo associado ao presente dividiu-se.
ID
 id integer

ID gerado pelo sistema para identificar exclusivamente uma divisão de presente.

v1. GivingApi.GivingPageAssociatedWithGift

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

Name Caminho Tipo Description
ID
 id integer

ID gerado pelo sistema para identificar exclusivamente uma página de oferta.
Nome
 name string

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

v1. GivingApi.GivingPageLeia

Página de Doação

Name Caminho Tipo Description
ID
 id integer

ID gerado pelo sistema para identificar exclusivamente uma página de oferta.
Nome
 name string

Nome da página que dá

v1. GivingApi.InfluencerRead

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

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

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

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

v1. GivingApi.PaymentAccountRead

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

Name Caminho Tipo Description
ID
 id integer

ID gerado 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

Recorde mapeado em Almabase

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

Um sistema atribuído ID exclusivo para o registro pelo banco de dados externo. Por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
Nome Próprio
 first_name string

Nome próprio do registo mapeado
Nome Completo
 formatted_name string

Nome completo do registo mapeado
ID
 id integer

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

Indicar se o registo mapeado ou o dador registado no Almabase
Apelido
 last_name string

Sobrenome do registro mapeado
URL da imagem
 present_picture uri

O url da imagem de registro
Link
 profile_url uri

O link de registro em Almabase

v1. GivingApi.TransactionRead

A transação de pagamento on-line associada ao presente.

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

A conta de pagamento associada à operação, por exemplo, BBMS, Stripe, PayPal, etc.
Criado(a) a
 created_at date-time

O momento da criação desta transação.
Motivo da falha
 failure_reason string

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

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

Status da transação. - 1 (Não processado) - 2 (Conseguido) - 3 (Reprovado) - 4 (Pendente) - 5 (Erro) NOTA: Estes estados estão associados ao estado da transação pelo Gateway de Pagamento
ID de Referência do Gateway de Pagamento
 transaction_id string

O ID exclusivo gerado pelo gateway de pagamento para identificar a transação. Por exemplo, ID de transação do Blackbaud Merchant Services (BBMS), ou ID de Stripe Charge, PayPal ID de transação

v1. AlmasightsApi.RecordAddOrEditar

Recorde em Almabase.

Name Caminho Tipo Description
ID
 id integer

ID gerado pelo sistema para identificar exclusivamente um registro.

v1. AlmasightsApi.TouchpointCustomObjectAdd

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

Name Caminho Tipo Description
Email
 email email

ID de e-mail usado para a atividade.
Gravar / Registo
 mapped_profile v1.AlmasightsApi.RecordAddOrEdit

Recorde em Almabase.
Gravado em
 recorded_at date-time

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

v1. RecordApi.LocationRead

Localização do endereço

Name Caminho Tipo Description
City
 city string

Nome da cidade do local
Country
 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

Address

Name Caminho Tipo Description
Linha1
 line1 string

Linha 1 do endereço
Linha2
 line2 string

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

Localização do endereço
Código postal
 zipcode string

CEP do endereço

v1. RecordApi.EmailWebhookRecordRead

Gravar / Registo

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

Um sistema atribuído ID exclusivo para o registro pelo banco de dados externo. Por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
Nome Próprio
 first_name string

Nome próprio do registo mapeado
ID
 id integer

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

Indicar se o registo mapeado está registado no Almabase
Apelido
 last_name string

Sobrenome do registro mapeado

v1. RecordApi.EmailWebhookResponse

Name Caminho Tipo Description
Endereço de E-mail
 data.address email

Endereço de e-mail.
ID
 data.id integer

ID gerado pelo sistema para identificar exclusivamente um e-mail.
É primário
 data.is_primary boolean

Indica se o e-mail é principal ou não.
esquema
 data.profile.schema v1.RecordApi.EmailWebhookRecordRead

Gravar / Registo
Tipo de e-mail
 data.type string

Tipo de endereço de e-mail (principal, pessoal, trabalho, etc).
Evento acionado em
 time string

A hora do evento.
Tipo de Evento
 type string

O tipo de evento.

v1. RecordApi.RecordWebhookResponse

Name Caminho Tipo Description
Affiliations
 data.affiliations array of string
Ano da Turma
 data.class_year string

Ano letivo do registo
Endereço de E-mail
 data.email email

Endereço de e-mail.
ID do banco de dados externo
 data.external_database_id string

Um sistema atribuído ID exclusivo para o registro pelo banco de dados externo. Por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
Nome Próprio
 data.first_name string

Nome próprio do registo mapeado
esquema
 data.home_address.schema v1.RecordApi.AddressRead

Address
ID
 data.id integer

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

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

Data de expiração da inscrição no registo
Nome do tipo de associação
 data.membership_type_name string

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

Número de telemóvel do registo
esquema
 data.office_address.schema v1.RecordApi.AddressRead

Address
Número de telefone do escritório
 data.office_phone_number string

Número de telefone do escritório do registro
Número de telefone da residência
 data.residence_phone_number string

Número de telefone de residência do registo
Evento acionado em
 time string

A hora do evento.
Tipo de Evento
 type string

O tipo de evento.

v1. RecordApi.EmailAddressRead

Endereço de E-mail

Name Caminho Tipo Description
Address
 address email

O endereço de e-mail
ID
 id integer

ID gerado pelo sistema para identificar exclusivamente um endereço de e-mail de um registro.
Está engajado?
 is_engaged boolean

Indica se um e-mail em massa é clicado ou aberto, ou se o usuário responde a um e-mail individual
Uso para login?
 is_login_email boolean

Indica se o utilizador tem permissão para iniciar sessão na Plataforma utilizando este endereço de e-mail.
É primário?
 is_primary boolean

Um e-mail principal é usado para enviar os e-mails automatizados acionados pelo Sistema. Ele também é usado para enviar o e-mail em massa para o registro. É obrigatório que apenas um e-mail seja definido como principal.
É verificado pelo utilizador?
 is_verified boolean

Indique se o usuário verificou que é o proprietário do e-mail.
origem
 source string

A fonte indica como o e-mail é adicionado ao banco de dados.
estado
 status string
Tipo
 type string

O tipo de e-mail

v1. RecordApi.RecordRead

registo

Name Caminho Tipo Description
Endereços de e-mail
 email_addresses array of v1.RecordApi.EmailAddressRead

Lista de endereços de e-mail de um perfil
ID do banco de dados externo
 external_database_id string

Um sistema atribuído ID exclusivo para o registro pelo banco de dados externo. Por exemplo, ID de registro do sistema para Raiser Edge NXT, ID de contato para Salesforce
Nome Próprio
 first_name string

Nome próprio do registo.
Nome Completo
 formatted_name string

Nome completo do registo.
ID
 id integer

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

Indicar se o registo ou dador registado na Almabase
Apelido
 last_name string

Apelido do registo.
URL da imagem
 present_picture uri

O url da imagem de registro
Link
 record_url uri

O link de registro em Almabase

v1. EventApi.ContactPersonRead

Pessoa de contacto de um evento

Name Caminho Tipo Description
Email
 email email

E-mail da pessoa de contacto
ID
 id integer

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

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

Número de telefone da pessoa de contacto

v1. EventApi.EventRead

Event

Name Caminho Tipo Description
Description
 description string

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

Hora de fim do evento
ID do banco de dados externo
 external_database_id string

Um sistema atribuído ID exclusivo 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 Registo Externo
 external_registration_url string

O url de inscrição do evento em um site externo
ID
 id integer

ID gerado 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