Compartilhar via

Interações NXT do Blackbaud Raisers Edge

O Blackbaud Raiser's Edge NXT é uma solução abrangente de software de captação de recursos e gerenciamento de doadores baseada em nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade de bem social. Use o conector de interações para gerenciar ações constituintes.

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 Blackbaud
URL https://www.blackbaud.com/support
Email skyapi@blackbaud.com
Metadados do conector
Publicador Blackbaud, Inc.
Site https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Política de privacidade https://www.blackbaud.com/privacy-shield
Categorias Vendas e CRM; Produtividade

O Raiser's Edge NXT é uma solução abrangente de software de captação de recursos e gerenciamento de doadores baseada em nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade de bem social.

Esse conector é criado com base na API SKY da Blackbaud e fornece operações para ajudar a gerenciar interações constituintes e entidades relacionadas no NXT de Borda do Raiser, incluindo:

  • Ações
  • Campos personalizados de ação
  • Anexos de ação
  • e muito mais...

Para obter mais informações, veja a documentação.

Pré-requisitos

Para usar esse conector, você deve ter uma conta de ID do Blackbaud com acesso a um ou mais ambientes Blackbaud.

Além disso, o administrador da sua organização também deve executar uma ação no nível do administrador dentro do sistema para permitir que esse conector acesse seu ambiente blackbaud. Mais informações sobre esses pré-requisitos podem ser encontradas na documentação de instalação inicial .

Como obter credenciais?

O administrador da sua organização enviará um convite para o ambiente do Raiser's Edge NXT da organização e configurará suas permissões de conta de usuário dentro do ambiente. Não são necessárias credenciais adicionais para usar esse conector.

Problemas e limitações conhecidos

O conector funcionará no contexto da sua conta de usuário e, portanto, estará sujeito às permissões do usuário dentro do ambiente.

Limitações

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

Ações

Atualizar um anexo de ação

Atualiza um anexo de ação.
Atualizar um campo personalizado de ação

Atualiza um campo personalizado de ação.
Atualizar uma ação constituinte

Atualiza uma ação constituinte.
Criar um anexo de ação

Cria um novo anexo de ação.
Criar um campo personalizado de ação

Cria um novo campo personalizado de ação.
Criar uma ação constituinte

Cria uma nova ação constituinte.
Listar anexos de ação

Lista os anexos de uma ação.
Listar ações

Retorna uma lista de ações.
Listar ações constituintes

Lista as ações de um constituinte.
Listar campos personalizados de ação

Lista os campos personalizados para uma ação.
Obter uma ação constituinte

Retorna informações sobre uma ação constituinte.

Atualizar um anexo de ação

ID da operação:
EditActionAttachment

Atualiza um anexo de ação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do anexo
 attachment_id True string

A ID do registro do sistema do anexo a ser atualizado.
Nome
 name string

O nome do anexo. Limite de caracteres: 150.
Date
 date date-time

A data do anexo (por exemplo: '2020-09-18T04:13:56Z').
URL
 url string

A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos.
Etiquetas
 tags array of string

As marcas associadas ao anexo.

Atualizar um campo personalizado de ação

ID da operação:
EditActionCustomField

Atualiza um campo personalizado de ação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do campo personalizado
 custom_field_id True string

A ID do registro do sistema do campo personalizado a ser atualizado.
body
 body True dynamic

Um objeto que representa as propriedades do campo personalizado a ser atualizado.

Atualizar uma ação constituinte

ID da operação:
EditAction

Atualiza uma ação constituinte.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da ação
 action_id True string

A ID do registro do sistema da ação a ser atualizada.
Date
 date date-time

A data da ação (por exemplo: '2020-09-18T04:13:56Z').
Categoria
 category string

O canal ou a intenção da interação constituinte.
Tipo
 type string

Descrição adicional da ação para complementar a categoria.
Resumo
 summary string

A breve descrição da ação que aparece na parte superior do registro. Limite de caracteres: 255.
Observação
 description string

A explicação detalhada que detalha o resumo da ação.
Concluído?
 completed boolean

A ação foi concluída? Se o sistema estiver configurado para usar status de ação personalizada, esse valor será baseado no valor do status da ação.
Concluído em
 completed_date date-time

A data em que a ação foi concluída (por exemplo: '2020-09-18T04:13:56Z').
Situação
 status string

O status da ação.
Direção
 direction string

A direção da ação.
Localização
 ___location string

O local da ação.
ID da oportunidade
 opportunity_id string

A ID do registro do sistema da oportunidade associada à ação.
Resultado
 outcome string

O resultado da ação.
Priority
 priority string

A prioridade da ação.
Hora de início
 start_time string

A hora de início da ação. Usa o tempo de 24 horas no formato HH:mm.
Hora de término
 end_time string

A hora de término da ação. Usa o tempo de 24 horas no formato HH:mm.
Arrecadação de fundos
 fundraisers array of string

O conjunto de IDs de registro do sistema para as arrecadações de fundos associadas à ação.

Criar um anexo de ação

ID da operação:
CreateActionAttachment

Cria um novo anexo de ação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da ação
 parent_id True string

A ID do registro do sistema da ação associada ao anexo.
Tipo
 type True string

O tipo de anexo. Anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Anexos de link são links para arquivos como imagens, postagens no blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente.
Nome
 name string

O nome do anexo. Limite de caracteres: 150.
Date
 date date-time

A data do anexo (por exemplo: '2020-09-18T04:13:56Z'). Esse campo usa como padrão a data e a hora atuais, se não for fornecido.
URL
 url string

A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos.
Nome do arquivo
 file_name string

O nome do arquivo. Limite de caracteres: 36. Somente para anexos físicos.
ID de Arquivo
 file_id string

O identificador do arquivo. Limite de caracteres: 36. Somente para anexos físicos.
ID da miniatura
 thumbnail_id string

O identificador da miniatura. Limite de caracteres: 36. Somente para anexos físicos.
Etiquetas
 tags array of string

As marcas associadas ao anexo.

Retornos

Anexo de ação criado

Corpo
ConstituentApi.CreatedActionAttachment

Criar um campo personalizado de ação

ID da operação:
CreateActionCustomField

Cria um novo campo personalizado de ação.

Parâmetros

Nome Chave Obrigatório Tipo Description
body
 body True dynamic

Um objeto que representa o campo personalizado a ser criado.

Retornos

Campo personalizado de ação criado

Corpo
ConstituentApi.CreatedActionCustomField

Criar uma ação constituinte

ID da operação:
CreateAction

Cria uma nova ação constituinte.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Constituinte
 constituent_id True string

A ID do registro do sistema do constituinte associado à ação.
Date
 date True date-time

A data da ação (por exemplo: '2020-09-18T04:13:56Z').
Categoria
 category True string

O canal ou a intenção da interação constituinte.
Tipo
 type string

Descrição adicional da ação para complementar a categoria.
Resumo
 summary string

A breve descrição da ação que aparece na parte superior do registro. Limite de caracteres: 255.
Observação
 description string

A explicação detalhada que detalha o resumo da ação.
Concluído?
 completed boolean

A ação foi concluída? Se o sistema estiver configurado para usar status de ação personalizada, esse valor será baseado no valor do status da ação.
Concluído em
 completed_date date-time

A data em que a ação foi concluída (por exemplo: '2020-09-18T04:13:56Z').
Situação
 status string

O status da ação.
Direção
 direction string

A direção da ação.
Localização
 ___location string

O local da ação.
ID da oportunidade
 opportunity_id string

A ID do registro do sistema da oportunidade associada à ação.
Resultado
 outcome string

O resultado da ação.
Priority
 priority string

A prioridade da ação.
Hora de início
 start_time string

A hora de início da ação. Usa o tempo de 24 horas no formato HH:mm.
Hora de término
 end_time string

A hora de término da ação. Usa o tempo de 24 horas no formato HH:mm.
Autor
 author string

O autor do resumo e da descrição da ação. Se não for fornecido, terá um conjunto padrão com base na conta do usuário. Limite de caracteres: 50.
Arrecadação de fundos
 fundraisers array of string

O conjunto de IDs de registro do sistema para as arrecadações de fundos associadas à ação.

Retornos

Ação criada

Corpo
ConstituentApi.CreatedAction

Listar anexos de ação

ID da operação:
ListActionAttachments

Lista os anexos de uma ação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da ação
 action_id True string

A ID do registro do sistema da ação.

Retornos

Attachments

Corpo
ConstituentApi.ApiCollectionOfActionAttachmentRead

Listar ações

ID da operação:
ListActions

Retorna uma lista de ações.

Parâmetros

Nome Chave Obrigatório Tipo Description
List
 list_id string

Define um identificador de lista usado para filtrar o conjunto de ações para aqueles incluídos na lista especificada. Se esse valor for definido, outros filtros especificados serão ignorados.
Status computado
 computed_status string

Representa um filtro para resultados com base no status da ação computada. Os valores disponíveis são Open, Completed ou PastDue.
Situação
 status_code string

Representa um código de status de ação para filtrar os resultados (aplicável somente quando o sistema é configurado para usar códigos de status de ação). Por exemplo, "Pendente" retorna ações com um status de "Pendente".
Limit
 limit integer

Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000.
Offset
 offset integer

Representa o número de registros a serem ignoradas. Para uso com paginação.
Adicionado em ou após
 date_added date-time

Filtre os resultados para ações criadas em ou após a data especificada (por exemplo: '2020-09-18T04:13:56Z').
Modificado em ou após
 last_modified date-time

Filtre os resultados para ações modificadas na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Retornos

Ações

Corpo
ConstituentApi.ApiCollectionOfActionRead

Listar ações constituintes

ID da operação:
ListConstituentActions

Lista as ações de um constituinte.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Constituinte
 constituent_id True string

A ID do registro do sistema do constituinte.

Retornos

Ações

Corpo
ConstituentApi.ApiCollectionOfActionRead

Listar campos personalizados de ação

ID da operação:
ListActionCustomFields

Lista os campos personalizados para uma ação.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da ação
 action_id True string

A ID do registro do sistema da ação.

Retornos

Campos Personalizados

Corpo
ConstituentApi.ApiCollectionOfActionCustomFieldRead

Obter uma ação constituinte

ID da operação:
GetAction

Retorna informações sobre uma ação constituinte.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID da ação
 action_id True string

A ID do registro do sistema da ação a ser obtido.

Retornos

Ação

Corpo
ConstituentApi.ActionRead

Definições

ConstituentApi.ActionAttachmentRead

Anexo

Nome Caminho Tipo Description
ID
 id string

A ID do registro do sistema do anexo.
ID da ação
 parent_id string

A ID do registro do sistema da ação associada ao anexo.
Tipo
 type string

O tipo de anexo. Anexos físicos são arquivos carregados, como imagens, PDFs ou documentos do Word que são salvos localmente ou na rede. Eles são armazenados e gerenciados no sistema. Anexos de link são links para arquivos como imagens, postagens no blog ou vídeos do YouTube que estão online ou em uma conta de armazenamento em nuvem. Eles são armazenados e gerenciados externamente.
Nome
 name string

O nome do anexo. Limite de caracteres: 150.
Date
 date date-time

A data do anexo.
URL
 url string

A URL do anexo. Isso é necessário para anexos de link e não aplicável a anexos físicos.
Nome do arquivo
 file_name string

O nome do arquivo. Limite de caracteres: 36. Somente para anexos físicos.
ID de Arquivo
 file_id string

O identificador do arquivo. Limite de caracteres: 36. Somente para anexos físicos.
ID da miniatura
 thumbnail_id string

O identificador da miniatura. Limite de caracteres: 36. Somente para anexos físicos.
URL de miniatura
 thumbnail_url string

A URL de uma miniatura. Para anexos físicos que são somente imagens. Contém uma assinatura associada ao tempo que limita o acesso a 60 minutos.
Tipo de conteúdo
 content_type string

O tipo de conteúdo. Somente para anexos físicos.
Tamanho do arquivo
 file_size integer

O tamanho do arquivo em bytes. Somente para anexos físicos.
Etiquetas
 tags array of string

As marcas associadas ao anexo.

ConstituentApi.ActionCustomFieldRead

Campo personalizado

Nome Caminho Tipo Description
ID
 id string

A ID do registro do sistema do campo personalizado.
ID da ação
 parent_id string

A ID do registro do sistema da ação associada ao campo personalizado.
Categoria
 category string

A categoria de campo personalizado.
Tipo
 type string

O tipo de dados que o campo personalizado representa.
Value
 value

O valor do campo personalizado.
Valor do texto
 text_value string

O valor do texto do campo personalizado.
Valor do número
 number_value integer

O valor numérico do campo personalizado.
Valor da data
 date_value date

O valor de data do campo personalizado.
Valor da moeda
 currency_value double

O valor da moeda do campo personalizado.
Valor booliano
 boolean_value boolean

O valor booliano do campo personalizado.
Valor de entrada da tabela
 codetableentry_value string

O valor de entrada da tabela do campo personalizado.
Valor da ID constituinte
 constituentid_value string

O valor da ID do constituinte do campo personalizado.
dia
 fuzzydate_value.d integer

O dia na data difusa.
month
 fuzzydate_value.m integer

O mês na data difusa.
ano
 fuzzydate_value.y integer

O ano na data difusa.
Date
 date date

A data no campo personalizado.
Comment
 comment string

O comentário no campo personalizado. Limite de caracteres: 50.
Data de inclusão
 date_added date-time

A data em que o campo personalizado foi criado.
Data modificada
 date_modified date-time

A data em que o campo personalizado foi modificado pela última vez.

ConstituentApi.ActionRead

Ação

Nome Caminho Tipo Description
ID
 id string

A ID do registro do sistema da ação.
ID do Constituinte
 constituent_id string

A ID do registro do sistema do constituinte associado à ação.
Categoria
 category string

O canal ou a intenção da interação constituinte.
Concluído?
 completed boolean

A ação foi concluída? Se o sistema estiver configurado para usar status de ação personalizada, esse valor será baseado no valor do status da ação.
Concluído em
 completed_date date-time

A data em que a ação foi concluída.
Date
 date date-time

A data da ação.
Observação
 description string

A explicação detalhada que detalha o resumo da ação.
Direção
 direction string

A direção da ação.
Arrecadação de fundos
 fundraisers array of string

O conjunto de IDs de registro do sistema para as arrecadações de fundos associadas à ação.
Localização
 ___location string

O local da ação.
ID da oportunidade
 opportunity_id string

A ID do registro do sistema da oportunidade associada à ação.
Resultado
 outcome string

O resultado da ação.
Priority
 priority string

A prioridade da ação.
Hora de início
 start_time string

A hora de início da ação. Usa o tempo de 24 horas no formato HH:mm.
Hora de término
 end_time string

A hora de término da ação. Usa o tempo de 24 horas no formato HH:mm.
Situação
 status string

O status da ação.
Código de status
 status_code string

O código de status da ação. Essa propriedade só é retornada quando o sistema é configurado para usar status de ação personalizada.
Status computado
 computed_status string

O status da ação computada. Se o sistema não estiver configurado para usar status de ação personalizada, esse campo calculará o status com base nas propriedades concluídas e de data. Caso contrário, o campo calculará o status com base na propriedade de data da ação e se a propriedade Action Status da ação está configurada como concluída.
Resumo
 summary string

A breve descrição da ação que aparece na parte superior do registro. Limite de caracteres: 255.
Tipo
 type string

Descrição adicional da ação para complementar a categoria.
Data de inclusão
 date_added date-time

A data em que a ação foi criada.
Data modificada
 date_modified date-time

A data em que a ação foi modificada pela última vez.

ConstituentApi.ApiCollectionOfActionAttachmentRead

Attachments

Nome Caminho Tipo Description
Contagem
 count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.
value
 value array of ConstituentApi.ActionAttachmentRead

O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfActionCustomFieldRead

Campos Personalizados

Nome Caminho Tipo Description
Contagem
 count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.
value
 value array of ConstituentApi.ActionCustomFieldRead

O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfActionRead

Ações

Nome Caminho Tipo Description
Contagem
 count integer

O número de itens disponíveis para recuperação na coleção depois de aplicar os parâmetros de solicitação. Os parâmetros de limite e deslocamento não afetam a contagem, mas, para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados do valor.
value
 value array of ConstituentApi.ActionRead

O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.CreatedAction

Ação criada

Nome Caminho Tipo Description
ID
 id string

A ID da ação recém-criada.

ConstituentApi.CreatedActionAttachment

Anexo de ação criado

Nome Caminho Tipo Description
ID
 id string

A ID do anexo de ação recém-criado.

ConstituentApi.CreatedActionCustomField

Campo personalizado de ação criado

Nome Caminho Tipo Description
ID
 id string

A ID do campo personalizado de ação recém-criado.