Blackbaud Raisers Edge NXT Interações

O Edge NXT da Blackbaud Raiser é uma solução abrangente de software de angariação de fundos e gestão de doadores baseada na nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade social. Use o conector Interações para gerenciar ações constituintes.

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 Blackbaud
URL	https://www.blackbaud.com/support
Email	skyapi@blackbaud.com

Metadados do conector
Editora	Blackbaud, Inc.
Sítio Web	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 angariação de fundos e gestão de doadores baseada na nuvem criada especificamente para organizações sem fins lucrativos e toda a comunidade social do bem.

Este conector é construído sobre a API SKY da Blackbaud e fornece operações para ajudar a gerenciar interações de constituintes e entidades relacionadas dentro do The Raiser's Edge NXT, incluindo:

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

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

Pré-requisitos

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

Além disso, o administrador da sua organização também deve executar uma ação de nível de 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 configuração inicial .

Como obter credenciais?

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

Problemas conhecidos e limitações

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

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de 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.
Campos personalizados de ação de lista	Lista os campos personalizados de uma ação.
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 para um constituinte.
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

Name	Chave	Necessário	Tipo	Description
ID do anexo	attachment_id	True	string	O ID de 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 (ex: '2020-09-18T04:13:56Z').
URL	url		string	O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos.
Etiquetas	tags		array of string	As tags associadas ao anexo.

Atualizar um campo personalizado de ação

ID da Operação:

EditActionCustomField

Atualiza um campo personalizado de ação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do campo personalizado	custom_field_id	True	string	O ID de 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

Name	Chave	Necessário	Tipo	Description
ID da ação	action_id	True	string	O ID de registro do sistema da ação a ser atualizada.
Date	date		date-time	A data da ação (ex: '2020-09-18T04:13:56Z').
Categoria	category		string	O canal ou 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 elabora o resumo da ação.
Concluído?	completed		boolean	A ação está concluída? Se o sistema estiver configurado para usar status de ação personalizados, esse valor será baseado no valor de status da ação.
Concluído a	completed_date		date-time	A data em que a ação foi concluída (ex: '2020-09-18T04:13:56Z').
Situação	status		string	O status da ação.
Direction	direction		string	A direção da ação.
Localização	location		string	O local da ação.
ID da oportunidade	opportunity_id		string	O ID de registro do sistema da oportunidade associada à ação.
Outcome	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 fim	end_time		string	A hora de fim da ação. Usa o tempo de 24 horas no formato HH:mm.
Angariação(ões) de fundos	fundraisers		array of string	O conjunto de IDs de registro do sistema para os angariadores de fundos associados à ação.

Campos personalizados de ação de lista

ID da Operação:

ListActionCustomFields

Lista os campos personalizados de uma ação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da ação	action_id	True	string	O ID de registro do sistema da ação.

Devoluções

Campos personalizados

Body

ConstituentApi.ApiCollectionOfActionCustomFieldRead

Criar um anexo de ação

ID da Operação:

CreateActionAttachment

Cria um novo anexo de ação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da ação	parent_id	True	string	O ID de registro do sistema da ação associada ao anexo.
Tipo	type	True	string	O tipo de anexo. Os 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. Os anexos de links são links para arquivos como imagens, postagens de 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 (ex: '2020-09-18T04:13:56Z'). Este campo assume como padrão a data e hora atuais se não for fornecido.
URL	url		string	O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos.
Nome do ficheiro	file_name		string	O nome do arquivo. Limite de caracteres: 36. Apenas para anexos físicos.
ID do ficheiro	file_id		string	O identificador do arquivo. Limite de caracteres: 36. Apenas para anexos físicos.
ID da miniatura	thumbnail_id		string	O identificador da miniatura. Limite de caracteres: 36. Apenas para anexos físicos.
Etiquetas	tags		array of string	As tags associadas ao anexo.

Devoluções

Anexo de ação criado

Body

ConstituentApi.CreatedActionAttachment

Criar um campo personalizado de ação

ID da Operação:

CreateActionCustomField

Cria um novo campo personalizado de ação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
body	body	True	dynamic	Um objeto que representa o campo personalizado a ser criado.

Devoluções

Campo personalizado de ação criado

Body

ConstituentApi.CreatedActionCustomField

Criar uma ação constituinte

ID da Operação:

CreateAction

Cria uma nova ação constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registro do sistema do constituinte associado à ação.
Date	date	True	date-time	A data da ação (ex: '2020-09-18T04:13:56Z').
Categoria	category	True	string	O canal ou 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 elabora o resumo da ação.
Concluído?	completed		boolean	A ação está concluída? Se o sistema estiver configurado para usar status de ação personalizados, esse valor será baseado no valor de status da ação.
Concluído a	completed_date		date-time	A data em que a ação foi concluída (ex: '2020-09-18T04:13:56Z').
Situação	status		string	O status da ação.
Direction	direction		string	A direção da ação.
Localização	location		string	O local da ação.
ID da oportunidade	opportunity_id		string	O ID de registro do sistema da oportunidade associada à ação.
Outcome	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 fim	end_time		string	A hora de fim da ação. Usa o tempo de 24 horas no formato HH:mm.
Author	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.
Angariação(ões) de fundos	fundraisers		array of string	O conjunto de IDs de registro do sistema para os angariadores de fundos associados à ação.

Devoluções

Ação criada

Body

ConstituentApi.CreatedAction

Listar anexos de ação

ID da Operação:

ListActionAttachments

Lista os anexos de uma ação.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da ação	action_id	True	string	O ID de registro do sistema da ação.

Devoluções

Attachments

Body

ConstituentApi.ApiCollectionOfActionAttachmentRead

Listar ações

ID da Operação:

ListActions

Retorna uma lista de ações.

Parâmetros

Name	Chave	Necessário	Tipo	Description
List	list_id		string	Define um identificador de lista usado para filtrar o conjunto de ações para aquelas incluídas na lista especificada. Se esse valor for definido, outros filtros especificados serão ignorados.
Estado calculado	computed_status		string	Representa um filtro para resultados com base no status da ação calculada. 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 está configurado para usar códigos de status de ação). Por exemplo, "Pendente" retorna ações com um status de "Pendente".
Limite	limit		integer	Representa o número de registros a serem retornados. O padrão é 500. O máximo é 5000.
Compensação	offset		integer	Representa o número de registros a serem ignorados. Para utilização com paginação.
Adicionado em ou após	date_added		date-time	Filtre os resultados para ações criadas na data especificada ou após ela (ex: '2020-09-18T04:13:56Z').
Modificado em ou após	last_modified		date-time	Filtre os resultados para ações modificadas na data especificada ou após ela (ex: '2020-09-18T04:13:56Z').

Devoluções

Ações

Body

ConstituentApi.ApiCollectionOfActionRead

Listar ações constituintes

ID da Operação:

ListConstituentActions

Lista as ações para um constituinte.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID do constituinte	constituent_id	True	string	O ID de registo do sistema do constituinte.

Devoluções

Ações

Body

ConstituentApi.ApiCollectionOfActionRead

Obter uma ação constituinte

ID da Operação:

GetAction

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

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da ação	action_id	True	string	O ID de registro do sistema da ação a ser obtida.

Devoluções

Ação

Body

ConstituentApi.ActionRead

Definições

ConstituentApi.ActionAttachmentRead

Anexo

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema do anexo.
ID da ação	parent_id	string	O ID de registro do sistema da ação associada ao anexo.
Tipo	type	string	O tipo de anexo. Os 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. Os anexos de links são links para arquivos como imagens, postagens de 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	O URL do anexo. Isso é necessário para anexos de link e não se aplica a anexos físicos.
Nome do ficheiro	file_name	string	O nome do arquivo. Limite de caracteres: 36. Apenas para anexos físicos.
ID do ficheiro	file_id	string	O identificador do arquivo. Limite de caracteres: 36. Apenas para anexos físicos.
ID da miniatura	thumbnail_id	string	O identificador da miniatura. Limite de caracteres: 36. Apenas para anexos físicos.
URL da miniatura	thumbnail_url	string	O URL de uma miniatura. Para anexos físicos que são apenas imagens. Contém uma assinatura com limite de tempo que limita o acesso a 60 minutos.
Tipo de conteúdo	content_type	string	O tipo de conteúdo. Apenas para anexos físicos.
Tamanho do ficheiro	file_size	integer	O tamanho do arquivo em bytes. Apenas para anexos físicos.
Etiquetas	tags	array of string	As tags associadas ao anexo.

ConstituentApi.ActionCustomFieldRead

Campo personalizado

Name	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema do campo personalizado.
ID da ação	parent_id	string	A ID de 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.
Valor	value		O valor do campo personalizado.
Valor do texto	text_value	string	O valor de 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 booleano	boolean_value	boolean	O valor booleano do campo personalizado.
Valor de entrada da tabela	codetableentry_value	string	O valor de entrada de tabela do campo personalizado.
Valor da ID do constituinte	constituentid_value	string	O valor de ID do constituinte do campo personalizado.
day	fuzzydate_value.d	integer	O dia na data difusa.
mês	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 adição	date_added	date-time	A data em que o campo personalizado foi criado.
Data de modificação	date_modified	date-time	A data em que o campo personalizado foi modificado pela última vez.

ConstituentApi.ActionRead

Ação

Name	Caminho	Tipo	Description
ID	id	string	O ID de registro do sistema da ação.
ID do constituinte	constituent_id	string	O ID de registro do sistema do constituinte associado à ação.
Categoria	category	string	O canal ou intenção da interação constituinte.
Concluído?	completed	boolean	A ação está concluída? Se o sistema estiver configurado para usar status de ação personalizados, esse valor será baseado no valor de status da ação.
Concluído a	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 elabora o resumo da ação.
Direction	direction	string	A direção da ação.
Angariação(ões) de fundos	fundraisers	array of string	O conjunto de IDs de registro do sistema para os angariadores de fundos associados à ação.
Localização	location	string	O local da ação.
ID da oportunidade	opportunity_id	string	O ID de registro do sistema da oportunidade associada à ação.
Outcome	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 fim	end_time	string	A hora de fim 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 estado	status_code	string	O código de status da ação. Essa propriedade só é retornada quando o sistema está configurado para usar status de ação personalizada.
Estado calculado	computed_status	string	O status da ação calculada. Se o sistema não estiver configurado para usar status de ação personalizados, esse campo calculará o status com base nas propriedades completed e date. Caso contrário, o campo calcula o status com base na propriedade date 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 adição	date_added	date-time	A data em que a ação foi criada.
Data de modificação	date_modified	date-time	A data em que a ação foi modificada pela última vez.

ConstituentApi.ApiCollectionOfActionAttachmentRead

Attachments

Name	Caminho	Tipo	Description
Contar	count	integer	O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.
valor	value	array of ConstituentApi.ActionAttachmentRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfActionCustomFieldRead

Campos personalizados

Name	Caminho	Tipo	Description
Contar	count	integer	O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.
valor	value	array of ConstituentApi.ActionCustomFieldRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.ApiCollectionOfActionRead

Ações

Name	Caminho	Tipo	Description
Contar	count	integer	O número de itens disponíveis para recuperação na coleção após a aplicação de quaisquer parâmetros de solicitação. Os parâmetros limit e offset não afetam a contagem, mas para facilitar a paginação, eles podem afetar o número de itens no conjunto de resultados de valor.
valor	value	array of ConstituentApi.ActionRead	O conjunto de itens incluídos na resposta. Este pode ser um subconjunto dos itens da coleção.

ConstituentApi.CreatedAction

Ação criada

Name	Caminho	Tipo	Description
ID	id	string	A ID da ação recém-criada.

ConstituentApi.CreatedActionAttachment

Anexo de ação criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do anexo de ação recém-criado.

ConstituentApi.CreatedActionCustomField

Campo personalizado de ação criado

Name	Caminho	Tipo	Description
ID	id	string	A ID do campo personalizado de ação recém-criado.