Blackbaud Raisers Edge NXT (versão prévia)

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.

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 entidades encontradas no NXT de Borda do Raiser, incluindo:

Constituintes
Presentes
Ações
Anotações
Campos personalizados
Campaigns
Fundos
Contestações
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 de administrador dentro do sistema para permitir que esse conector acesse o NXT de Borda do Raiser. 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	500	60 segundos

Ações

Adicionar registros a uma lista	Adicione um conjunto de registros a uma lista existente.
Adicionar um presente ao lote	Adicione um presente ao lote de presentes especificado.
Atualizar detalhes de confirmação do presente	Atualiza os detalhes de confirmação de um presente.
Atualizar detalhes do recibo do presente	Atualiza os detalhes do recibo de um presente.
Atualizar um alias constituinte	Atualiza um alias constituinte.
Atualizar um anexo constituinte	Atualiza um anexo constituinte.
Atualizar um anexo de ação	Atualiza um anexo de ação.
Atualizar um anexo de campanha	Atualiza um anexo de campanha.
Atualizar um anexo de fundo	Atualiza um anexo de fundo.
Atualizar um anexo de oportunidade	Atualiza um anexo de oportunidade.
Atualizar um anexo de presente	Atualiza um anexo de presente.
Atualizar um anexo de recurso	Atualiza um anexo de recurso.
Atualizar um campo personalizado constituinte	Atualiza um campo personalizado constituinte.
Atualizar um campo personalizado de ação	Atualiza um campo personalizado de ação.
Atualizar um campo personalizado de campanha	Atualiza um campo personalizado de campanha.
Atualizar um campo personalizado de oportunidade	Atualiza um campo personalizado de oportunidade.
Atualizar um campo personalizado de presente	Atualiza um campo personalizado de presente.
Atualizar um campo personalizado de recurso	Atualiza um campo personalizado de recurso.
Atualizar um campo personalizado do fundo	Atualiza um campo personalizado do fundo.
Atualizar um constituinte	Atualiza um constituinte.
Atualizar um código constituinte	Atualiza um código constituinte.
Atualizar um código de solicitação constituinte	Atualiza um código de solicitação constituinte.
Atualizar um endereço constituinte	Atualiza um endereço constituinte.
Atualizar um endereço de email constituinte	Atualiza um endereço de email constituinte.
Atualizar um evento	Atualiza os detalhes sobre um evento.
Atualizar um participante	Atualiza os detalhes sobre um participante.
Atualizar um telefone constituinte	Atualiza um telefone constituinte.
Atualizar uma ação constituinte	Atualiza uma ação constituinte.
Atualizar uma educação constituinte	Atualiza uma educação constituinte.
Atualizar uma imagem de perfil constituinte	Atualiza a imagem de perfil atual para um constituinte.
Atualizar uma nota constituinte	Atualiza uma nota constituinte.
Atualizar uma oportunidade	Atualiza uma oportunidade.
Atualizar uma opção de participante	Atualiza os detalhes sobre uma opção de participante.
Atualizar uma presença online constituinte	Atualiza uma presença online constituinte.
Atualizar uma relação constituinte	Atualiza uma relação para um constituinte. Se houver uma relação recíproca, ela também será modificada para refletir as alterações. Isso não inclui alterações na propriedade "comments", que é específica para cada registro e pode ser modificada independentemente em cada registro.
Criar um alias constituinte	Cria um novo alias constituinte.
Criar um anexo constituinte	Cria um novo anexo constituinte.
Criar um anexo de ação	Cria um novo anexo de ação.
Criar um anexo de campanha	Cria um novo anexo de campanha.
Criar um anexo de fundo	Cria um novo anexo de fundo.
Criar um anexo de oportunidade	Cria um novo anexo de oportunidade.
Criar um anexo de presente	Cria um novo anexo de presente.
Criar um anexo de recurso	Cria um novo anexo de recurso.
Criar um campo personalizado constituinte	Cria um novo campo personalizado constituinte.
Criar um campo personalizado de ação	Cria um novo campo personalizado de ação.
Criar um campo personalizado de campanha	Cria um novo campo personalizado de campanha.
Criar um campo personalizado de oportunidade	Cria um novo campo personalizado de oportunidade.
Criar um campo personalizado de presente	Cria um novo campo personalizado de presente.
Criar um campo personalizado de recurso	Cria um novo campo personalizado de recurso.
Criar um campo personalizado do fundo	Cria um novo campo personalizado do fundo.
Criar um constituinte da organização	Cria um novo constituinte da organização.
Criar um constituinte individual	Cria um novo constituinte individual.
Criar um código constituinte	Cria um novo código constituinte.
Criar um código de solicitação constituinte	Cria um novo código de solicitação constituinte.
Criar um endereço constituinte	Cria um novo endereço constituinte.
Criar um endereço de email constituinte	Cria um novo endereço de email constituinte.
Criar um evento	Cria um novo evento.
Criar um local de documento	Cria um novo identificador de documento exclusivo e um local de upload para uso com anexos físicos. A resposta incluirá instruções sobre onde e como carregar o conteúdo do documento.
Criar um lote de presentes	Cria um novo lote de presentes.
Criar um pagamento de taxa de participante	Cria um novo pagamento de taxa para um participante.
Criar um participante	Cria um novo participante para um evento.
Criar um presente	Cria um novo presente.
Criar um registro de consentimento constituinte	Cria um novo registro de consentimento constituinte.
Criar um relacionamento de organização	Cria uma nova relação de organização. Se a relação for com outro constituinte, uma relação recíproca será criada para esse constituinte.
Criar um telefone constituinte	Cria um novo telefone constituinte.
Criar uma atribuição de arrecadação de fundos	Cria uma nova tarefa de arrecadação de fundos.
Criar uma ação constituinte	Cria uma nova ação constituinte.
Criar uma classificação constituinte	Cria uma nova classificação constituinte.
Criar uma doação de participante	Cria uma nova doação para um participante.
Criar uma educação constituinte	Cria uma nova educação constituinte.
Criar uma lista com base em um conjunto de registros	Cria uma nova lista filtrada para o conjunto de registros especificado.
Criar uma nota constituinte	Cria uma nova nota constituinte.
Criar uma oportunidade	Cria uma nova oportunidade.
Criar uma opção de participante	Cria uma nova opção de participante para um participante.
Criar uma opção de participante de evento	Cria uma nova opção de participante para um evento.
Criar uma presença online constituinte	Cria uma nova presença online constituinte.
Criar uma relação individual	Cria uma nova relação individual. Se a relação for com outro constituinte, uma relação recíproca será criada para esse constituinte.
Criar uma taxa de evento	Cria uma nova taxa para um evento.
Criar uma taxa de participante	Cria uma nova taxa para um participante.
Excluir um código constituinte	Exclui um código constituinte.
Listar aliases constituintes	Lista os aliases de um constituinte.
Listar anexos constituintes	Lista os anexos de um constituinte.
Listar anexos de ação	Lista os anexos de uma ação.
Listar anexos de campanha	Lista os anexos de uma campanha.
Listar anexos de fundos	Lista os anexos de um fundo.
Listar anexos de oportunidade	Lista os anexos para uma oportunidade.
Listar anexos de presentes	Lista os anexos de um presente.
Listar anexos de recurso	Lista os anexos de um recurso.
Listar anotações constituintes	Lista as anotações de um constituinte.
Listar arrecadações de fundos constituintes	Lista as atribuições de arrecadação de fundos para um constituinte.
Listar atribuições de arrecadação de fundos	Liste as tarefas para uma arrecadação de fundos.
Listar ações	Retorna uma lista de ações.
Listar ações constituintes	Lista as ações de um constituinte.
Listar campanhas	Retorna uma lista de campanhas.
Listar campos personalizados constituintes	Lista os campos personalizados para um constituinte.
Listar campos personalizados da campanha	Lista os campos personalizados para uma campanha.
Listar campos personalizados de ação	Lista os campos personalizados para uma ação.
Listar campos personalizados de oportunidade	Lista os campos personalizados para uma oportunidade.
Listar campos personalizados de presentes	Lista os campos personalizados para um presente.
Listar campos personalizados de recurso	Lista os campos personalizados para um recurso.
Listar campos personalizados do fundo	Lista os campos personalizados para um fundo.
Listar classificações constituintes	Retorna a lista de classificações para um constituinte.
Listar constituintes	Retorna uma lista de constituintes.
Listar códigos constituintes	Lista os códigos constituintes para um constituinte.
Listar códigos de solicitação constituintes	Lista os códigos de solicitação para um constituinte.
Listar doações de participantes	Lista as doações para um participante.
Listar educaçãos constituintes	Lista os registros de educação de um constituinte.
Listar endereços constituintes	Lista os endereços de um constituinte.
Listar endereços de email constituintes	Lista os endereços de email de um constituinte.
Listar eventos	Retorna uma lista de eventos.
Listar fundos	Retorna uma lista de fundos.
Listar lotes de presentes	Liste os lotes de presentes.
Listar oportunidades	Retorna uma lista de oportunidades.
Listar opções de participantes do evento	Lista as opções de participante para um evento.
Listar pacotes	Retorna uma lista de pacotes.
Listar pagamentos de taxa de participante	Lista os pagamentos de taxa para um participante.
Listar participantes do evento	Lista os participantes de um evento.
Listar presentes	Retorna uma lista de presentes.
Listar presenças online constituintes	Lista as presenças online de um constituinte.
Listar recursos	Retorna uma lista de recursos.
Listar registros de consentimento do constituinte	Lista os registros de consentimento de um constituinte.
Listar relações constituintes	Lista as relações de um constituinte.
Listar taxas de evento	Lista as taxas de um evento.
Listar taxas de participantes	Lista as taxas para um participante.
Listar telefones constituintes	Lista os telefones de um constituinte.
Obter a concessão do tempo de vida do constituinte	Retorna o tempo de vida dando resumo para um constituinte.
Obter o maior presente constituinte	Retorna o maior presente para um constituinte.
Obter o primeiro presente constituinte	Retorna o primeiro presente para um constituinte.
Obter o último presente constituinte	Retorna o último presente para um constituinte.
Obter status de perspectiva constituinte	Retorna o status de perspectiva atual para um constituinte.
Obter um constituinte	Retorna informações sobre um constituinte.
Obter um evento	Retorna informações sobre um evento.
Obter um fundo	Retorna informações sobre um fundo.
Obter um pacote	Retorna informações sobre um pacote.
Obter um participante	Retorna informações sobre um participante de evento específico.
Obter um presente	Retorna informações sobre um presente.
Obter um recurso	Retorna informações sobre um recurso.
Obter uma ação constituinte	Retorna informações sobre uma ação constituinte.
Obter uma campanha	Retorna informações sobre uma campanha.
Obter uma imagem de perfil constituinte	Retorna a imagem de perfil atual de um constituinte.
Obter uma oportunidade	Retorna informações sobre uma oportunidade. Observação: esse ponto de extremidade retorna a propriedade de status com uma latência de cerca de 10 minutos.
Opções de participante de lista	Lista as opções de participante para um participante.
Pesquisar um constituinte	Executa uma pesquisa constituinte com base no texto de pesquisa fornecido. Dá suporte ao nome, sobrenome, nome preferencial, nome antigo, alias, endereço de email, número de telefone, endereço ou ID de pesquisa. Combinações de nomes como nome e sobrenome ou nome preferencial e sobrenome são válidas, mas caso contrário, a pesquisa só dá suporte a um parâmetro de cada vez. Por padrão, as pesquisas incluem resultados que soam semelhantes aos seus critérios. Por exemplo, as pesquisas por "Smith" incluem correspondências para "Smyth" e outras ortografias alternativas. Essa pesquisa não dá suporte a caracteres curinga como * ou ?. Os resultados da pesquisa são limitados a 500 registros.

Adicionar registros a uma lista

ID da operação:: AppendIDsToList

Adicione um conjunto de registros a uma lista existente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Tipo de lista	list_type	True	string	O tipo de lista.
List	list_id	True	string	A ID do registro do sistema da lista.
ID(s)	ids	True	array of string	Os identificadores exclusivos para os registros a serem adicionados à lista (máximo de 100.000 valores).

Adicionar um presente ao lote

ID da operação:: AddGiftToBatch

Adicione um presente ao lote de presentes especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Lote	batch_id	True	string	O lote ao qual o presente será adicionado.
ID do Constituinte	constituent_id	True	string	A ID do registro do sistema do constituinte associado ao presente.
Quantidade	value	True	double	A quantidade monetária do presente.
Date	date	True	date	A data do presente (por exemplo: '2020-09-18').
Tipo	type	True	string	O tipo de presente.
ID da campanha	campaign_id		string	A ID do registro do sistema da campanha associada à divisão de presentes.
ID do fundo	fund_id	True	string	A ID do registro do sistema do fundo associado à divisão de presentes.
ID de recurso	appeal_id		string	A ID do registro do sistema do recurso associado à divisão do presente.
ID do pacote	package_id		string	A ID do registro do sistema do pacote associado à divisão de presentes.
quantidade	value	True	double	A quantidade monetária da divisão do presente.
Método de pagamento	payment_method	True	string	A forma de pagamento.
Número de verificação	check_number		string	O número de verificação (aplicável somente quando a forma de pagamento é "PersonalCheck").
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Referência	reference		string	A referência de pagamento (aplicável somente quando a forma de pagamento é "Outros").
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
É anônimo?	is_anonymous		boolean	O presente é anônimo? Se nenhum valor for fornecido, o anonimato padrão do doador será usado.
Subtipo	subtype		string	O subtipo do presente.
Comment	reference		string	Notas para acompanhar detalhes especiais sobre um presente, como a motivação por trás dele ou uma descrição detalhada de um presente em espécie.
ID de pesquisa	lookup_id		string	O identificador definido pelo usuário para o presente.
Usar créditos de arrecadação de fundos?	default_fundraiser_credits		boolean	Usar os créditos padrão de arrecadação de fundos?
Usar créditos suaves?	default_soft_credits		boolean	Usar os créditos soft padrão?
Círculo eleitoral	constituency		string	O eleitorado do presente.
Status da postagem	post_status		string	O status da postagem do presente.
Data da postagem	post_date		date	A data em que o presente foi postado (ex: '2020-09-18').
Status do recebimento	status	True	string	O status de recebimento do presente.
Valor do recibo	value	True	double	O valor monetário do recibo do presente.
Data de recebimento	date		date	A data em que o presente foi recibo (por exemplo: '2020-09-18').

Retornos

Contém uma coleção de registros de erro de presente em lotes e os presentes em lote que a operação adicionou

Results: GiftApi.BatchGiftAddResults

Atualizar detalhes de confirmação do presente

ID da operação:: EditGiftAcknowledgement

Atualiza os detalhes de confirmação de um presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de confirmação	acknowledgement_id	True	string	A ID de registro do sistema da confirmação do presente a ser atualizada. Ele usa a ID do presente pai como seu valor.
Situação	status		string	O status da confirmação. Quando o status é definido como DoNotAcknowledge, a carta e a data devem ser nulas. Quando o status é definido como NeedsAcknowledgement, a data deve ser nula.
Date	date		date-time	A data associada à confirmação (por exemplo: '2020-09-18T04:13:56Z').
Letra	letter		string	A carta associada à confirmação.

Atualizar detalhes do recibo do presente

ID da operação:: EditGiftReceipt

Atualiza os detalhes do recibo de um presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do recibo	receipt_id	True	string	A ID do registro do sistema do recibo de presente a ser atualizado. Ele usa a ID do presente pai como seu valor.
Situação	status		string	O status de recebimento do presente. Quando o status é definido como NeedsReceipt ou DoNotReceipt, a data de recebimento deve ser nula.
value	value		double	O valor monetário.
Date	date		date-time	A data no recibo (por exemplo: '2020-09-18T04:13:56Z').
Número	number		integer	O número do recibo.

Atualizar um alias constituinte

ID da operação:: EditConstituentAlias

Atualiza um alias constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Alias ID	alias_id	True	string	A ID do registro do sistema do alias a ser atualizado.
Alias	name		string	O nome a ser usado como alias do constituinte. Limite de caracteres: 100.
Tipo	type		string	O tipo de alias.

Atualizar um anexo constituinte

ID da operação:: EditConstituentAttachment

Atualiza um anexo constituinte.

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.

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.

Atualizar um anexo de campanha

ID da operação:: EditCampaignAttachment

Atualiza um anexo de campanha.

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.

Atualizar um anexo de fundo

ID da operação:: EditFundAttachment

Atualiza um anexo de fundo.

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.

Atualizar um anexo de oportunidade

ID da operação:: EditOpportunityAttachment

Atualiza um anexo de oportunidade.

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.

Atualizar um anexo de presente

ID da operação:: EditGiftAttachment

Atualiza um anexo de presente.

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.

Atualizar um anexo de recurso

ID da operação:: EditAppealAttachment

Atualiza um anexo de recurso.

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.

Atualizar um campo personalizado constituinte

ID da operação:: EditConstituentCustomField

Atualiza um campo personalizado constituinte.

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 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 um campo personalizado de campanha

ID da operação:: EditCampaignCustomField

Atualiza um campo personalizado de campanha.

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 um campo personalizado de oportunidade

ID da operação:: EditOpportunityCustomField

Atualiza um campo personalizado de oportunidade.

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 um campo personalizado de presente

ID da operação:: EditGiftCustomField

Atualiza um campo personalizado de presente.

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 um campo personalizado de recurso

ID da operação:: EditAppealCustomField

Atualiza um campo personalizado de recurso.

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 um campo personalizado do fundo

ID da operação:: EditFundCustomField

Atualiza um campo personalizado do fundo.

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 um constituinte

ID da operação:: EditConstituent

Atualiza um constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	constituent_id	True	string	A ID de registro do sistema do constituinte a ser atualizada.
Title	title		string	O título primário do constituinte (somente para indivíduos).
Nome	first		string	O nome do constituinte (somente para indivíduos). Limite de caracteres: 50.
Sobrenome	last		string	O sobrenome do constituinte (somente para indivíduos). Limite de caracteres: 100.
Nome da organização	name		string	Para indivíduos, esse é um campo computado que não é aplicável para operações de edição. Para a organização, esse campo é necessário e representa o nome da organização. Limite de caracteres: 100.
Sufixo	suffix		string	O sufixo primário do constituinte (somente para indivíduos).
Nome preferencial	preferred_name		string	O nome preferencial do constituinte (somente para indivíduos). Limite de caracteres: 50.
ID de pesquisa	lookup_id		string	O identificador definido pelo usuário para o constituinte.
Gênero	gender		string	O gênero do constituinte (somente para indivíduos).
Nome do meio	middle		string	O nome do meio do constituinte (somente para indivíduos). Limite de caracteres: 50.
Nome antigo	former_name		string	O nome antigo do constituinte (somente para indivíduos). Limite de caracteres: 100.
Título 2	title_2		string	O título secundário do constituinte (somente para indivíduos).
Sufixo 2	suffix_2		string	O sufixo secundário do constituinte (somente para indivíduos).
Estado civil	marital_status		string	O estado civil do constituinte (somente para indivíduos).
Dá anonimamente?	gives_anonymously		boolean	O constituinte dá anonimamente?
Inativo?	inactive		boolean	O constituinte está inativo?
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Terra natal	birthplace		string	O local de nascimento do constituinte (somente para indivíduos).
Etnia	ethnicity		string	A etnia do constituinte (somente para indivíduos).
Rendimento	income		string	A renda do constituinte (somente para pessoas físicas).
Religião	religion		string	A religião do constituinte (somente para indivíduos).
Setor	industry		string	A indústria do constituinte (somente para organizações).
Número de funcionários	num_employees		integer	O número de funcionários da organização.
Corresponde a presentes?	matches_gifts		boolean	A organização corresponde a presentes?
Fator presente correspondente	matching_gift_factor		double	O fator presente correspondente (somente para organizações).
Correspondência mínima por presente	value		double	A quantidade mínima de correspondência por presente para o constituinte (somente para organizações).
Correspondência máxima por presente	value		double	A quantidade máxima de correspondência por presente para o constituinte (somente para organizações).
Correspondência mínima por constit	value		double	O total mínimo de correspondência para o constituinte (somente para organizações).
Correspondência máxima por constit	value		double	O total máximo de correspondências para o constituinte (somente para organizações).
Notas de presente correspondentes	matching_gift_notes		string	As notas de presente correspondentes para o constituinte (somente para organizações).
Falecido?	deceased		boolean	O constituinte está falecido (somente para indivíduos)?
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.

Atualizar um código constituinte

ID da operação:: EditConstituentCode

Atualiza um código constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do código constituinte	constituent_code_id	True	string	A ID do registro do sistema do código constituinte a ser atualizado.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Sequence	sequence		integer	A sequência numérica associada ao código constituinte.

Atualizar um código de solicitação constituinte

ID da operação:: EditConstituentSolicitCode

Atualiza um código de solicitação constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Solicitar ID de código	constituent_solicit_code_id	True	string	A ID do registro do sistema do código de solicitação a ser atualizado.
Solicitar código	solicit_code		string	Instruções de comunicação e/ou restrições para um constituinte.
Data de início	start_date		date	A data de início do código de solicitação (por exemplo: '2005-09-18').
Data de término	end_date		date	A data de término do código de solicitação (por exemplo: '2005-09-18').

Atualizar um endereço constituinte

ID da operação:: EditConstituentAddress

Atualiza um endereço constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do endereço	address_id	True	string	A ID do registro do sistema do endereço a ser atualizado.
Tipo de endereço	type		string	O tipo de endereço.
País	country		string	O país do endereço (pode ser a ID, o nome ou a abreviação).
Linhas de endereço	address_lines		string	As linhas de endereço.
City	city		string	A cidade do endereço (não use em combinação com o campo Subúrbio).
Estado	state		string	O estado do endereço.
CEP	postal_code		string	O código postal do endereço.
Subúrbio	suburb		string	O subúrbio do endereço (não use em combinação com o campo Cidade).
Município	county		string	A região do endereço.
Fonte de informações	information_source		string	A fonte de informações do endereço.
Região	region		string	A região do endereço.
CARROÇA	cart		string	A rota da transportadora (CART) para o endereço.
LOTE	lot		string	A linha de viagem (LOT) para o endereço.
DPC	dpc		string	O código do ponto de entrega (DPC) para o endereço.
Válido a partir de	start		date	A data em que o constituinte começou a residir neste endereço (por exemplo: '2005-09-18').
Válida até	end		date	A data em que o constituinte deixou de residir neste endereço (por exemplo: '2005-09-18').
Primário?	preferred		boolean	Este é o endereço preferencial do constituinte?
Não enviar emails?	do_not_mail		boolean	O constituinte pode ser contatado neste endereço?
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.

Atualizar um endereço de email constituinte

ID da operação:: EditConstituentEmailAddress

Atualiza um endereço de email constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do endereço de email	email_address_id	True	string	A ID do registro do sistema do endereço de email a ser atualizado.
Tipo de email	type		string	O tipo de endereço de email.
Endereço de email	address		string	O endereço de email.
Primário?	primary		boolean	Este é o endereço de email principal do constituinte?
Não enviar email?	do_not_email		boolean	O constituinte pode ser contatado neste endereço de email?
Inativo?	inactive		boolean	Esse endereço de email está inativo?

Atualizar um evento

ID da operação:: EditEvent

Atualiza os detalhes sobre um evento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do evento	event_id	True	string	A ID do registro do sistema do evento a ser atualizado.
Nome do evento	name		string	O nome do evento.
Description	description		string	A descrição do evento.
Categoria	name	True	string	O nome da categoria.
Data de início	start_date		date	A data de início do evento (por exemplo: '2020-09-18').
Hora de início	start_time		string	A hora de início do evento (ex: '07:30').
Data de término	end_date		date	A data de término do evento (por exemplo: '2020-09-18').
Hora de término	end_time		string	A hora de término do evento (ex: '07:30').
ID de pesquisa	lookup_id		string	A ID de pesquisa do evento.
Capacity	capacity		integer	O número de pessoas que podem participar do evento.
Goal	goal		double	A meta monetária do evento.
ID da Campanha	campaign_id		string	A ID de registro do sistema da campanha associada ao evento.
ID do fundo	fund_id		string	A ID do registro do sistema do fundo associado ao evento.
Inativo?	inactive		boolean	O evento está ativo?

Atualizar um participante

ID da operação:: EditParticipant

Atualiza os detalhes sobre um participante.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do participante	participant_id	True	string	A ID do registro do sistema do participante a ser atualizado.
ID do Constituinte	constituent_id		string	A ID constituinte do participante.
Host ID	host_id		string	A ID do registro de participante do host.
Status do RSVP	rsvp_status		string	O status do envolvimento do participante com o evento.
Participou?	attended		boolean	O participante participou do evento?
Status do convite	invitation_status		string	O status do convite para o participante.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Nível de participação	name	True	string	O nome do nível de participação.

Atualizar um telefone constituinte

ID da operação:: EditConstituentPhone

Atualiza um telefone constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do telefone	phone_id	True	string	A ID do registro do sistema do telefone a ser atualizado.
Tipo	type		string	O tipo de telefone.
Número	number		string	O número de telefone.
Primário?	primary		boolean	Este é o telefone primário do constituinte?
Não ligar?	do_not_call		boolean	O constituinte pode ser contatado neste número?
Inativo?	inactive		boolean	Esse número de telefone está inativo?

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.
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 (por exemplo: '2020-09-18T04:13:56Z').
Date	date		date-time	A data da ação (por exemplo: '2020-09-18T04:13:56Z').
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.
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.

Atualizar uma educação constituinte

ID da operação:: EditConstituentEducation

Atualiza uma educação constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da educação	education_id	True	string	A ID de registro do sistema do registro educacional a ser atualizado.
Escola	school		string	O nome da escola/estabelecimento.
Tipo	type		string	O tipo de educação.
Classe de	class_of		string	O ano em que o constituinte se formou.
Situação	status		string	O status da educação.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Grau	degree		string	O grau recebido.
GPA	gpa		double	A média de pontos de nota.
Assunto de estudo	subject_of_study		string	O assunto do estudo.
Primário?	primary		boolean	Esta é a associação de escola primária do constituinte?
Majors	majors		array of string	Os principais cursos de estudo.
Menores	minors		array of string	Os cursos secundários de estudo.
Campus	campus		string	O campus. Limite de caracteres: 50.
Organização social	social_organization		string	A organização social. Limite de caracteres: 50.
Nome conhecido	known_name		string	O nome conhecido. Limite de caracteres: 50.
Classe de grau	class_of_degree		string	A classe de grau.
Departamento	department		string	O nome do departamento de educação.
Faculdade	faculty		string	O nome da faculdade.
Número de registro	registration_number		string	O número do registro. Limite de caracteres: 50.

Atualizar uma imagem de perfil constituinte

ID da operação:: EditConstituentProfilePicture

Atualiza a imagem de perfil atual para 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 cuja imagem de perfil deve ser atualizada.
Nome do arquivo	file_name	True	string	O nome do arquivo.
ID do documento	document_id	True	uuid	O identificador do documento.
ID da miniatura	thumbnail_id	True	uuid	O identificador do documento em miniatura.

Atualizar uma nota constituinte

ID da operação:: EditConstituentNote

Atualiza uma nota constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da anotação	note_id	True	string	A ID do registro do sistema da nota a ser atualizada.
Tipo	type		string	O tipo de anotação.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Resumo	summary		string	O resumo da anotação. Limite de caracteres: 50.
Observação	text		string	O texto da anotação.

Atualizar uma oportunidade

ID da operação:: EditOpportunity

Atualiza uma oportunidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da oportunidade	opportunity_id	True	string	A ID de registro do sistema da oportunidade de atualizar.
Propósito	purpose		string	O uso pretendido para qualquer dinheiro arrecadado como resultado da oportunidade.
Nome	name		string	O nome que identifica a oportunidade em todo o programa, como em listas ou em registros constituintes. Limite de caracteres: 255.
Situação	status		string	O status que indica onde a oportunidade está no processo de solicitação.
Data limite	deadline		date-time	A data da meta para a oportunidade de resultar em um presente (por exemplo: '2020-09-18T04:13:56Z').
Data da pergunta	ask_date		date-time	A data em que a solicitação foi feita (por exemplo: '2020-09-18T04:13:56Z').
value	value		double	O valor monetário.
Data esperada	expected_date		date-time	A data em que a perspectiva deve ceder em resposta à oportunidade (por exemplo: '2020-09-18T04:13:56Z').
value	value		double	O valor monetário.
Data financiada	funded_date		date-time	A data em que o prospecto deu em resposta à oportunidade (por exemplo: '2020-09-18T04:13:56Z').
value	value		double	O valor monetário.
ID da Campanha	campaign_id		string	A ID de registro do sistema da campanha associada à oportunidade. A campanha define os objetivos gerais para arrecadar dinheiro.
ID do fundo	fund_id		string	A ID de registro do sistema do fundo associado à oportunidade. O fundo designa a finalidade financeira específica de um presente e identifica a conta financeira desse presente.
ID do Constituinte	constituent_id		string	A ID do registro do sistema do constituinte associado à arrecadação de fundos.
value	value		double	O valor monetário.
Inativo?	inactive		boolean	A oportunidade está inativa?

Atualizar uma opção de participante

ID da operação:: EditParticipantOption

Atualiza os detalhes sobre uma opção de participante.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da opção de participante	option_id	True	string	A ID de registro do sistema da opção participante a ser atualizada.
Value	option_value	True	string	A resposta do participante à opção.

Atualizar uma presença online constituinte

ID da operação:: EditConstituentOnlinePresence

Atualiza uma presença online constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de presença online	online_presence_id	True	string	A ID de registro do sistema da presença online a ser atualizada.
Tipo	type		string	O tipo de presença online.
Link	address		string	O endereço da Web para a presença online.
Primário?	primary		boolean	Esta é a principal presença online do constituinte?
Inativo?	inactive		boolean	Essa presença online está inativa?

Atualizar uma relação constituinte

ID da operação:: EditConstituentRelationship

Atualiza uma relação para um constituinte. Se houver uma relação recíproca, ela também será modificada para refletir as alterações. Isso não inclui alterações na propriedade "comments", que é específica para cada registro e pode ser modificada independentemente em cada registro.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da relação	relationship_id	True	string	A ID do registro do sistema da relação a ser atualizada.
Tipo	type		string	O tipo de relação que a relação representa.
Tipo recíproco	reciprocal_type		string	Descreve a relação do constituinte com o constituinte relacionado. Por exemplo, em uma relação entre um constituinte masculino e um irmão feminino, o tipo de relação recíproca seria irmão.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
O cônjuge é?	is_spouse		boolean	O indivíduo relacionado é o cônjuge do constituinte (aplica-se apenas às relações entre indivíduos)?
É o chefe de família constituinte?	is_constituent_head_of_household		boolean	O constituinte é o chefe da casa?
O cônjuge é o chefe da casa?	is_spouse_head_of_household		boolean	O cônjuge é o chefe da casa?
Anotações	comment		string	Notas adicionais sobre a relação.
O contato é?	is_organization_contact		boolean	O constituinte representa essa organização como um contato (aplica-se apenas a relações entre organizações e indivíduos)?
Os negócios primários são os principais?	is_primary_business		boolean	Esse é o principal negócio do constituinte (aplica-se apenas às relações entre organizações e indivíduos)?
Tipo de contato	organization_contact_type		string	Fornece contexto para interações com o indivíduo relacionado que representa a organização como um contato. Aplica-se apenas a relações entre organizações e indivíduos.
Cargo	position		string	A posição do indivíduo na organização. Aplica-se apenas a relações entre organizações e indivíduos. Limite de caracteres: 50.

Criar um alias constituinte

ID da operação:: CreateConstituentAlias

Cria um novo alias 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 ao alias.
Alias	name	True	string	O nome a ser usado como alias do constituinte. Limite de caracteres: 100.
Tipo	type		string	O tipo de alias.

Retornos

Alias constituinte criado

Corpo: ConstituentApi.CreatedConstituentAlias

Criar um anexo constituinte

ID da operação:: CreateConstituentAttachment

Cria um novo anexo constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	parent_id	True	string	A ID do registro do sistema do constituinte associado 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.

Retornos

Anexo constituinte criado

Corpo: ConstituentApi.CreatedConstituentAttachment

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.

Retornos

Anexo de ação criado

Corpo: ConstituentApi.CreatedActionAttachment

Criar um anexo de campanha

ID da operação:: CreateCampaignAttachment

Cria um novo anexo de campanha.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da Campanha	parent_id	True	string	A ID do registro do sistema da campanha 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.

Retornos

Anexo de campanha criado

Corpo: FundraisingApi.CreatedCampaignAttachment

Criar um anexo de fundo

ID da operação:: CreateFundAttachment

Cria um novo anexo de fundo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do fundo	parent_id	True	string	A ID do registro do sistema do fundo associado 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.

Retornos

Anexo de fundo criado

Corpo: FundraisingApi.CreatedFundAttachment

Criar um anexo de oportunidade

ID da operação:: CreateOpportunityAttachment

Cria um novo anexo de oportunidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da oportunidade	parent_id	True	string	A ID do registro do sistema da oportunidade 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.

Retornos

Anexo de oportunidade criado

Corpo: OpportunityApi.CreatedOpportunityAttachment

Criar um anexo de presente

ID da operação:: CreateGiftAttachment

Cria um novo anexo de presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do presente	parent_id	True	string	A ID do registro do sistema do presente associado 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.

Retornos

Anexo de presente criado

Corpo: GiftApi.CreatedGiftAttachment

Criar um anexo de recurso

ID da operação:: CreateAppealAttachment

Cria um novo anexo de recurso.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de recurso	parent_id	True	string	A ID do registro do sistema do recurso associado 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.

Retornos

Anexo de recurso criado

Corpo: FundraisingApi.CreatedAppealAttachment

Criar um campo personalizado constituinte

ID da operação:: CreateConstituentCustomField

Cria um novo campo personalizado constituinte.

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 constituinte criado

Corpo: ConstituentApi.CreatedConstituentCustomField

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 um campo personalizado de campanha

ID da operação:: CreateCampaignCustomField

Cria um novo campo personalizado de campanha.

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 campanha criado

Corpo: FundraisingApi.CreatedCampaignCustomField

Criar um campo personalizado de oportunidade

ID da operação:: CreateOpportunityCustomField

Cria um novo campo personalizado de oportunidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
body	body	True	dynamic	Um objeto que representa o campo personalizado a ser criado.

Retornos

Anexo de oportunidade criado

Corpo: OpportunityApi.CreatedOpportunityCustomField

Criar um campo personalizado de presente

ID da operação:: CreateGiftCustomField

Cria um novo campo personalizado de presente.

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 presente criado

Corpo: GiftApi.CreatedGiftCustomField

Criar um campo personalizado de recurso

ID da operação:: CreateAppealCustomField

Cria um novo campo personalizado de recurso.

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 recurso criado

Corpo: FundraisingApi.CreatedAppealCustomField

Criar um campo personalizado do fundo

ID da operação:: CreateFundCustomField

Cria um novo campo personalizado do fundo.

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 do fundo criado

Corpo: FundraisingApi.CreatedFundCustomField

Criar um constituinte da organização

ID da operação:: CreateOrganizationConstituent

Cria um novo constituinte da organização.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome	name	True	string	O nome da organização. Limite de caracteres: 100.
ID de pesquisa	lookup_id		string	O identificador definido pelo usuário para o constituinte.
tipo	type	True	string	O tipo de endereço.
country	country		string	O país do endereço (pode ser a ID, o nome ou a abreviação).
Linhas	address_lines		string	As linhas de endereço. Limite de caracteres: 150.
city	city		string	A cidade do endereço (não use em combinação com o campo Subúrbio).
estado	state		string	O estado do endereço.
código postal	postal_code		string	O código postal do endereço. Limite de caracteres: 12.
subúrbio	suburb		string	O subúrbio do endereço (não use em combinação com o campo Cidade).
condado	county		string	A região do endereço.
start	start		date	A data em que o constituinte começou a residir neste endereço (por exemplo: '2005-09-18').
término	end		date	A data em que o constituinte deixou de residir neste endereço (por exemplo: '2005-09-18').
tipo	type	True	string	O tipo de telefone.
número	number	True	string	O número de telefone.
é primário?	primary		boolean	Este é o número de telefone primário do constituinte?
tipo	type	True	string	O tipo de endereço de email.
address	address	True	string	O endereço de email.
é primário?	primary		boolean	Este é o endereço de email principal do constituinte?
tipo	type	True	string	O tipo de presença online.
address	address	True	string	O endereço da Web para a presença online.
é primário?	primary		boolean	Esta é a principal presença online do constituinte?
Dá anonimamente?	gives_anonymously		boolean	O constituinte dá anonimamente?
Setor	industry		string	A indústria do constituinte.
Número de funcionários	num_employees		integer	O número de funcionários da organização.
Corresponde a presentes?	matches_gifts		boolean	A organização corresponde a presentes?
Fator presente correspondente	matching_gift_factor		double	O fator presente correspondente.
Correspondência mínima por presente	value		double	A quantidade mínima de correspondência por presente para o constituinte.
Correspondência máxima por presente	value		double	A quantidade máxima de correspondência por presente para o constituinte.
Correspondência mínima por constit	value		double	O total mínimo de correspondência para o constituinte.
Correspondência máxima por constit	value		double	O total máximo de correspondências para o constituinte.
Notas de presente correspondentes	matching_gift_notes		string	As notas de presente correspondentes para o constituinte.

Retornos

Constituinte da organização criado

Corpo: ConstituentApi.CreatedOrganizationConstituent

Criar um constituinte individual

ID da operação:: CreateIndividualConstituent

Cria um novo constituinte individual.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Title	title		string	O título primário do constituinte.
Nome	first		string	O nome do constituinte. Limite de caracteres: 50.
Sobrenome	last	True	string	O sobrenome do constituinte. Limite de caracteres: 100.
Sufixo	suffix		string	O sufixo primário do constituinte.
ID de pesquisa	lookup_id		string	O identificador definido pelo usuário para o constituinte.
tipo	type	True	string	O tipo de endereço.
country	country		string	O país do endereço (pode ser a ID, o nome ou a abreviação).
Linhas	address_lines		string	As linhas de endereço. Limite de caracteres: 150.
city	city		string	A cidade do endereço (não use em combinação com o campo Subúrbio).
estado	state		string	O estado do endereço.
código postal	postal_code		string	O código postal do endereço. Limite de caracteres: 12.
subúrbio	suburb		string	O subúrbio do endereço (não use em combinação com o campo Cidade).
condado	county		string	A região do endereço.
start	start		date	A data em que o constituinte começou a residir neste endereço (por exemplo: '2005-09-18').
término	end		date	A data em que o constituinte deixou de residir neste endereço (por exemplo: '2005-09-18').
tipo	type	True	string	O tipo de telefone.
número	number	True	string	O número de telefone.
é primário?	primary		boolean	Este é o número de telefone primário do constituinte?
tipo	type	True	string	O tipo de endereço de email.
address	address	True	string	O endereço de email.
é primário?	primary		boolean	Este é o endereço de email principal do constituinte?
tipo	type	True	string	O tipo de presença online.
address	address	True	string	O endereço da Web para a presença online.
é primário?	primary		boolean	Esta é a principal presença online do constituinte?
Nome preferencial	preferred_name		string	O nome preferencial do constituinte. Limite de caracteres: 50.
Nome do meio	middle		string	O nome do meio do constituinte. Limite de caracteres: 50.
Nome antigo	former_name		string	O nome antigo do constituinte. Limite de caracteres: 100.
Título 2	title_2		string	O título secundário do constituinte.
Sufixo 2	suffix_2		string	O sufixo secundário do constituinte.
Gênero	gender		string	O gênero do constituinte.
Estado civil	marital_status		string	O estado civil do constituinte.
Dá anonimamente?	gives_anonymously		boolean	O constituinte dá anonimamente?
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Terra natal	birthplace		string	O local de nascimento do constituinte.
Etnia	ethnicity		string	A etnia do constituinte.
Rendimento	income		string	A renda do constituinte.
Religião	religion		string	A religião do constituinte.
Destinatário personalizado?	custom_format		boolean	O destinatário primário é um formato personalizado?
Formato do destinatário	configuration_id		string	Configuração do destinatário primário (necessária, a menos que um formato personalizado seja usado).
Nome personalizado do destinatário	formatted_name		string	Nome formatado do destinatário primário (necessário quando um formato personalizado é usado). Limite de caracteres: 255.
Saudação personalizada?	custom_format		boolean	A saudação primária é um formato personalizado?
Formato de saudação	configuration_id		string	Configuração de saudação primária (necessária, a menos que um formato personalizado seja usado).
Nome personalizado de saudação	formatted_name		string	Nome formatado de saudação primária (necessário quando um formato personalizado é usado). Limite de caracteres: 255.

Retornos

Constituinte individual criado

Corpo: ConstituentApi.CreatedIndividualConstituent

Criar um código constituinte

ID da operação:: CreateConstituentCode

Cria um novo código 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 ao código constituinte.
Código constituinte	description	True	string	O código constituinte.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Sequence	sequence		integer	A sequência numérica associada ao código constituinte.

Retornos

Código constituinte criado

Corpo: ConstituentApi.CreatedConstituentCode

Criar um código de solicitação constituinte

ID da operação:: CreateConstituentSolicitCode

Cria um novo código de solicitaçã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 ao código de solicitação.
Solicitar código	solicit_code	True	string	Instruções de comunicação e/ou restrições para um constituinte.
Data de início	start_date		date	A data de início do código de solicitação (por exemplo: '2005-09-18').
Data de término	end_date		date	A data de término do código de solicitação (por exemplo: '2005-09-18').

Retornos

Código de solicitação constituinte criado

Corpo: CommPrefApi.CreatedConstituentSolicitCode

Criar um endereço constituinte

ID da operação:: CreateConstituentAddress

Cria um novo endereç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 ao endereço.
Tipo de endereço	type	True	string	O tipo de endereço.
País	country		string	O país do endereço (pode ser a ID, o nome ou a abreviação).
Linhas de endereço	address_lines		string	As linhas de endereço.
City	city		string	A cidade do endereço (não use em combinação com o campo Subúrbio).
Estado	state		string	O estado do endereço.
CEP	postal_code		string	O código postal do endereço.
Subúrbio	suburb		string	O subúrbio do endereço (não use em combinação com o campo Cidade).
Município	county		string	A região do endereço.
Fonte de informações	information_source		string	A fonte de informações do endereço.
Região	region		string	A região do endereço.
CARROÇA	cart		string	A rota da transportadora (CART) para o endereço.
LOTE	lot		string	A linha de viagem (LOT) para o endereço.
DPC	dpc		string	O código do ponto de entrega (DPC) para o endereço.
Válido a partir de	start		date	A data em que o constituinte começou a residir neste endereço (por exemplo: '2005-09-18').
Válida até	end		date	A data em que o constituinte deixou de residir neste endereço (por exemplo: '2005-09-18').
Primário?	preferred		boolean	Este é o endereço preferencial do constituinte?
Não enviar emails?	do_not_mail		boolean	O constituinte pode ser contatado neste endereço?
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.

Retornos

Endereço constituinte criado

Corpo: ConstituentApi.CreatedConstituentAddress

Criar um endereço de email constituinte

ID da operação:: CreateConstituentEmailAddress

Cria um novo endereço de email 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 ao endereço de email.
Tipo de email	type	True	string	O tipo de endereço de email.
Endereço de email	address	True	string	O endereço de email.
Primário?	primary		boolean	Este é o endereço de email principal do constituinte?
Não enviar email?	do_not_email		boolean	O constituinte pode ser contatado neste endereço de email?
Inativo?	inactive		boolean	Esse endereço de email está inativo?

Retornos

Endereço de email constituinte criado

Corpo: ConstituentApi.CreatedConstituentEmailAddress

Criar um evento

ID da operação:: CreateEvent

Cria um novo evento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do evento	name	True	string	O nome do evento.
Description	description		string	A descrição do evento.
Categoria	name	True	string	O nome da categoria.
Data de início	start_date	True	date	A data de início do evento (por exemplo: '2020-09-18').
Hora de início	start_time		string	A hora de início do evento (ex: '07:30').
Data de término	end_date		date	A data de término do evento (por exemplo: '2020-09-18').
Hora de término	end_time		string	A hora de término do evento (por exemplo: '07:30)'.
ID de pesquisa	lookup_id		string	A ID de pesquisa do evento.
Capacity	capacity		integer	O número de pessoas que podem participar do evento.
Goal	goal		double	A meta monetária do evento.
ID da Campanha	campaign_id		string	A ID de registro do sistema da campanha associada ao evento.
ID do fundo	fund_id		string	A ID do registro do sistema do fundo associado ao evento.
Inativo?	inactive		boolean	O evento está ativo?

Retornos

Evento criado

Corpo: EventApi.CreatedEvent

Criar um local de documento

ID da operação:: CreateDocument

Cria um novo identificador de documento exclusivo e um local de upload para uso com anexos físicos. A resposta incluirá instruções sobre onde e como carregar o conteúdo do documento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome do arquivo	file_name		string	O nome do arquivo a ser carregado.
Incluir miniatura?	upload_thumbnail		boolean	Incluir um local de documento em miniatura?

Retornos

Definição de arquivo

Corpo: ConstituentApi.FileDefinition

Criar um lote de presentes

ID da operação:: CreateGiftBatch

Cria um novo lote de presentes.

Parâmetros

Nome	Chave	Tipo	Description
Description	batch_description	string	A descrição do lote.
Número esperado	expected_number	integer	O número de presentes esperados no lote.
Total esperado	expected_batch_total	double	O valor total dos presentes no lote.
Número do lote	batch_number	string	O identificador exclusivo específico do lote.

Retornos

Lote de presentes criado

Corpo: GiftBatchApi.CreatedBatch

Criar um pagamento de taxa de participante

ID da operação:: CreateParticipantFeePayment

Cria um novo pagamento de taxa para um participante.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do participante	participant_id	True	string	A ID do registro do sistema do participante.
ID do presente	gift_id	True	string	A ID do registro de systetm do presente ao qual a taxa do participante está vinculada.
Valor aplicado	applied_amount	True	double	O valor do pagamento que se aplica às taxas dos participantes.

Retornos

Pagamento de taxa de participante criado

Corpo: EventApi.CreatedParticipantFeePayment

Criar um participante

ID da operação:: CreateParticipant

Cria um novo participante para um evento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do evento	event_id	True	string	A ID do registro do sistema do evento.
ID do Constituinte	constituent_id	True	string	A ID constituinte do participante.
Host ID	host_id		string	A ID do registro de participante do host.
Status do RSVP	rsvp_status		string	O status do envolvimento do participante com o evento.
Participou?	attended		boolean	O participante participou do evento?
Status do convite	invitation_status		string	O status do convite para o participante.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Nível de participação	name	True	string	O nome do nível de participação.

Retornos

Participante criado

Corpo: EventApi.CreatedParticipant

Criar um presente

ID da operação:: CreateGift

Cria um novo presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	constituent_id	True	string	A ID do registro do sistema do constituinte associado ao presente.
Quantidade	value	True	double	A quantidade monetária do presente.
Date	date	True	date	A data do presente (por exemplo: '2020-09-18').
Tipo	type	True	string	O tipo de presente.
ID da campanha	campaign_id		string	A ID do registro do sistema da campanha associada à divisão de presentes.
ID do fundo	fund_id	True	string	A ID do registro do sistema do fundo associado à divisão de presentes.
ID de recurso	appeal_id		string	A ID do registro do sistema do recurso associado à divisão do presente.
ID do pacote	package_id		string	A ID do registro do sistema do pacote associado à divisão de presentes.
quantidade	value	True	double	A quantidade monetária da divisão do presente.
Método de pagamento	payment_method	True	string	A forma de pagamento.
Número de verificação	check_number		string	O número de verificação (aplicável somente quando a forma de pagamento é "PersonalCheck").
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Referência	reference		string	A referência de pagamento (aplicável somente quando a forma de pagamento é "Outros").
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
É anônimo?	is_anonymous		boolean	O presente é anônimo? Se nenhum valor for fornecido, o anonimato padrão do doador será usado.
Subtipo	subtype		string	O subtipo do presente.
Comment	reference		string	Notas para acompanhar detalhes especiais sobre um presente, como a motivação por trás dele ou uma descrição detalhada de um presente em espécie.
ID de pesquisa	lookup_id		string	O identificador definido pelo usuário para o presente.
Usar créditos de arrecadação de fundos?	default_fundraiser_credits		boolean	Usar os créditos padrão de arrecadação de fundos?
Usar créditos suaves?	default_soft_credits		boolean	Usar os créditos soft padrão?
Círculo eleitoral	constituency		string	O eleitorado do presente.
Prefixo do lote	batch_prefix		string	O prefixo a ser usado para presentes em lotes. Isso deve incluir pelo menos uma letra e é necessário quando 'Número do Lote' tem um valor.
Número do lote	batch_number		string	O número do lote. Limite de caracteres: 50 (incluindo o prefixo em lote).
Status da postagem	post_status		string	O status da postagem do presente.
Data da postagem	post_date		date	A data em que o presente foi postado (ex: '2020-09-18').
Status do recebimento	status	True	string	O status de recebimento do presente.
Valor do recibo	value	True	double	O valor monetário do recibo do presente.
Data de recebimento	date		date	A data em que o presente foi recibo (por exemplo: '2020-09-18').

Retornos

Presente criado

Corpo: GiftApi.CreatedGift

Criar um registro de consentimento constituinte

ID da operação:: CreateConstituentConsent

Cria um novo registro de consentimento 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 ao registro de consentimento.
Channel	channel	True	string	O canal ao qual a resposta de consentimento se aplica.
Categoria	category		string	A categoria à qual a resposta de consentimento se aplica.
Source	source		string	A origem da resposta de consentimento do constituinte.
Resposta	constituent_consent_response	True	string	Como o constituinte respondeu ao consentimento do canal/categoria especificado.
Date	consent_date	True	date-time	A data em que a resposta de consentimento foi recebida (por exemplo: '2020-09-18T04:13:56Z').
Instrução de consentimento	consent_statement		string	A declaração à qual o constituinte respondeu ao fornecer consentimento.
Aviso de privacidade	privacy_notice		string	O aviso de privacidade fornecido ao constituinte.

Retornos

Consentimento constituinte criado

Corpo: CommPrefApi.CreatedConstituentConsent

Criar um relacionamento de organização

ID da operação:: CreateOrganizationRelationship

Cria uma nova relação de organização. Se a relação for com outro constituinte, uma relação recíproca será criada para esse 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 à relação.
ID da relação	relation_id	True	string	A ID de registro do sistema da organização relacionada.
Tipo	type		string	O tipo de relação que a relação representa.
Tipo recíproco	reciprocal_type		string	Descreve a relação do constituinte com a organização relacionada.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
O contato é?	is_organization_contact		boolean	O constituinte representa essa organização como um contato?
Tipo de contato	organization_contact_type		string	Fornece contexto para interações com o indivíduo relacionado que representa a organização como um contato.
Cargo	position		string	A posição do indivíduo na organização. Limite de caracteres: 50.
Os negócios primários são os principais?	is_primary_business		boolean	Este é o principal negócio do constituinte?
Anotações	comment		string	Notas adicionais sobre a relação.

Retornos

Relação de organização criada

Corpo: ConstituentApi.CreatedOrganizationRelationship

Criar um telefone constituinte

ID da operação:: CreateConstituentPhone

Cria um novo telefone 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 ao telefone.
Tipo	type	True	string	O tipo de telefone.
Número	number	True	string	O número de telefone.
Primário?	primary		boolean	Este é o telefone primário do constituinte?
Não ligar?	do_not_call		boolean	O constituinte pode ser contatado neste número?
Inativo?	inactive		boolean	Esse número de telefone está inativo?

Retornos

Telefone constituinte criado

Corpo: ConstituentApi.CreatedConstituentPhone

Criar uma atribuição de arrecadação de fundos

ID da operação:: CreateFundraiserAssignment

Cria uma nova tarefa de arrecadação de fundos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da arrecadação de fundos	fundraiser_id	True	string	A ID do registro do sistema da arrecadação de fundos.
ID do Constituinte	constituent_id	True	string	A ID do registro do sistema do constituinte atribuído.
Tipo	type		string	O tipo de arrecadação de fundos.
Início da atribuição	start		date-time	A data de início da atribuição.
Termina a atribuição	end		date-time	A data de término da atribuição.
Quantidade	value	True	double	O valor da meta para a arrecadação de fundos solicitar do constituinte atribuído.
ID da Campanha	campaign_id		string	A ID de registro do sistema da campanha à qual os presentes resultantes serão aplicados.
ID do fundo	fund_id		string	A ID de registro do sistema do fundo ao qual os presentes resultantes serão aplicados.
ID de recurso	appeal_id		string	A ID do registro do sistema do recurso ao qual os presentes resultantes serão aplicados.

Retornos

Criação de atribuição de arrecadação de fundos

Corpo: FundraisingApi.CreatedFundraiserAssignment

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.
Categoria	category	True	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 (por exemplo: '2020-09-18T04:13:56Z').
Date	date	True	date-time	A data da ação (por exemplo: '2020-09-18T04:13:56Z').
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.
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.

Retornos

Ação criada

Corpo: ConstituentApi.CreatedAction

Criar uma classificação constituinte

ID da operação:: CreateConstituentRating

Cria uma nova classificação constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
body	body	True	dynamic	Um objeto que representa a classificação a ser criada.

Retornos

Classificação constituinte criada

Corpo: ConstituentApi.CreatedConstituentRating

Criar uma doação de participante

ID da operação:: CreateParticipantDonation

Cria uma nova doação para um participante.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do participante	participant_id	True	string	A ID do registro do sistema do participante.
ID do presente	gift_id	True	string	A ID do registro de systetm do presente ao qual a doação do participante está vinculada.

Retornos

Doação de participante criada

Corpo: EventApi.CreatedParticipantDonation

Criar uma educação constituinte

ID da operação:: CreateConstituentEducation

Cria uma nova educação constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	constituent_id	True	string	A ID de registro do sistema do constituinte associado à educação.
Escola	school	True	string	O nome da escola/estabelecimento.
Tipo	type		string	O tipo de educação.
Classe de	class_of		string	O ano em que o constituinte se formou.
Situação	status		string	O status da educação.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Grau	degree		string	O grau recebido.
GPA	gpa		double	A média de pontos de nota.
Assunto de estudo	subject_of_study		string	O assunto do estudo.
Primário?	primary		boolean	Esta é a associação de escola primária do constituinte?
Majors	majors		array of string	Os principais cursos de estudo.
Menores	minors		array of string	Os cursos secundários de estudo.
Campus	campus		string	O campus. Limite de caracteres: 50.
Organização social	social_organization		string	A organização social. Limite de caracteres: 50.
Nome conhecido	known_name		string	O nome conhecido. Limite de caracteres: 50.
Classe de grau	class_of_degree		string	A classe de grau (aplicável somente para versões do Reino Unido).
Departamento	department		string	O nome do departamento de educação (aplicável apenas para versões do Reino Unido).
Faculdade	faculty		string	O nome do corpo docente (aplicável somente para versões do Reino Unido).
Número de registro	registration_number		string	O número de registro (aplicável somente para versões do Reino Unido). Limite de caracteres: 50.

Retornos

Educação constituinte criada

Corpo: ConstituentApi.CreatedConstituentEducation

Criar uma lista com base em um conjunto de registros

ID da operação:: CreateListFromIDs

Cria uma nova lista filtrada para o conjunto de registros especificado.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Nome	name	True	string	O nome da lista. Limite de caracteres: 50.
Description	description	True	string	A descrição da lista.
Tipo de lista	list_type	True	string	Determina o tipo de lista a ser criada.
Permissions	list_permissions	True	string	Determina se outros usuários podem acessar a lista.
ID(s)	ids	True	array of string	Os identificadores exclusivos dos registros contidos na lista (máximo de 100.000 valores).

Retornos

Lista criada

Corpo: ListApi.CreatedList

Criar uma nota constituinte

ID da operação:: CreateConstituentNote

Cria uma nova nota 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 à anotação.
Tipo	type	True	string	O tipo de anotação.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
Resumo	summary		string	O resumo da anotação. Limite de caracteres: 50.
Observação	text		string	O texto da anotação.

Retornos

Anotação constituinte criada

Corpo: ConstituentApi.CreatedConstituentNote

Criar uma oportunidade

ID da operação:: CreateOpportunity

Cria uma nova oportunidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	constituent_id	True	string	A ID do registro do sistema do constituinte associado à oportunidade.
Propósito	purpose	True	string	O uso pretendido para qualquer dinheiro arrecadado como resultado da oportunidade.
Nome	name	True	string	O nome que identifica a oportunidade em todo o programa, como em listas ou em registros constituintes. Limite de caracteres: 255.
Situação	status		string	O status que indica onde a oportunidade está no processo de solicitação.
Data limite	deadline		date-time	A data da meta para a oportunidade de resultar em um presente (por exemplo: '2020-09-18T04:13:56Z').
Data da pergunta	ask_date		date-time	A data em que a solicitação foi feita (por exemplo: '2020-09-18T04:13:56Z').
value	value		double	O valor monetário.
Data esperada	expected_date		date-time	A data em que a perspectiva deve ceder em resposta à oportunidade (por exemplo: '2020-09-18T04:13:56Z').
value	value		double	O valor monetário.
Data financiada	funded_date		date-time	A data em que o prospecto deu em resposta à oportunidade (por exemplo: '2020-09-18T04:13:56Z').
value	value		double	O valor monetário.
ID da Campanha	campaign_id		string	A ID de registro do sistema da campanha associada à oportunidade. A campanha define os objetivos gerais para arrecadar dinheiro.
ID do fundo	fund_id		string	A ID de registro do sistema do fundo associado à oportunidade. O fundo designa a finalidade financeira específica de um presente e identifica a conta financeira desse presente.
ID do Constituinte	constituent_id		string	A ID do registro do sistema do constituinte associado à arrecadação de fundos.
value	value		double	O valor monetário.
Inativo?	inactive		boolean	A oportunidade está inativa?

Retornos

Oportunidade criada

Corpo: OpportunityApi.CreatedOpportunity

Criar uma opção de participante

ID da operação:: CreateParticipantOption

Cria uma nova opção de participante para um participante.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do participante	participant_id	True	string	A ID do participante.
body	body	True	dynamic	Um objeto que representa a opção participante a ser criada.

Retornos

Opção de participante criado

Corpo: EventApi.CreatedParticipantOption

Criar uma opção de participante de evento

ID da operação:: CreateEventParticipantOption

Cria uma nova opção de participante para um evento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do evento	event_id	True	string	A ID do evento.
Nome	name	True	string	O nome da opção de participante do evento.
Tipo de entrada	input_type	True	string	Os tipos de valores que os participantes podem usar para fornecer respostas.
Permitir seleção múltipla?	multi_select		boolean	Permitir mais de um valor para listas?
nome	name		string	O nome da opção de lista.
sequência	sequence		integer	A sequência baseada em 0 usada para ordenação.

Retornos

Opção de participante de evento criado

Corpo: EventApi.CreatedEventParticipantOption

Criar uma presença online constituinte

ID da operação:: CreateConstituentOnlinePresence

Cria uma nova presença online 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 à presença online.
Tipo	type	True	string	O tipo de presença online.
Link	address	True	string	O endereço da Web para a presença online.
Primário?	primary		boolean	Esta é a principal presença online do constituinte?
Inativo?	inactive		boolean	Essa presença online está inativa?

Retornos

Presença online constituinte criada

Corpo: ConstituentApi.CreatedConstituentOnlinePresence

Criar uma relação individual

ID da operação:: CreateIndividualRelationship

Cria uma nova relação individual. Se a relação for com outro constituinte, uma relação recíproca será criada para esse 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 à relação.
ID da relação	relation_id	True	string	A ID do registro do sistema do indivíduo relacionado.
Tipo	type		string	O tipo de relação que a relação representa.
Tipo recíproco	reciprocal_type		string	Descreve a relação do constituinte com o constituinte relacionado. Por exemplo, em uma relação entre um constituinte masculino e um irmão feminino, o tipo de relação recíproca seria irmão.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.
O cônjuge é?	is_spouse		boolean	O indivíduo relacionado é o cônjuge do constituinte?
É o chefe de família constituinte?	is_constituent_head_of_household		boolean	O constituinte é o chefe da casa?
O cônjuge é o chefe da casa?	is_spouse_head_of_household		boolean	O cônjuge é o chefe da casa?
Anotações	comment		string	Notas adicionais sobre a relação.

Retornos

Relação individual criada

Corpo: ConstituentApi.CreatedIndividualRelationship

Criar uma taxa de evento

ID da operação:: CreateEventFee

Cria uma nova taxa para um evento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do evento	event_id	True	string	A ID do registro do sistema do evento.
Nome	name	True	string	O nome da taxa.
Valor da taxa	cost	True	double	A quantidade de dinheiro associada à taxa.
Valor da contribuição	contribution_amount	True	double	O valor da taxa que é uma doação acima dos custos do evento.

Retornos

Taxa de evento criada

Corpo: EventApi.CreatedEventFee

Criar uma taxa de participante

ID da operação:: CreateParticipantFee

Cria uma nova taxa para um participante.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do participante	participant_id	True	string	A ID do registro do sistema do participante.
ID do evento	event_id	True	string	A ID do registro do sistema do evento.
Taxa	event_fee_id	True	string	O valor do evento.
Quantidade	quantity	True	integer	A quantidade comprada.
Valor da taxa	fee_amount	True	double	A quantidade de dinheiro associada à taxa.
Valor da contribuição	contribution_amount	True	double	O valor da taxa que é uma doação acima dos custos do evento. Esse é o valor que normalmente aparece nos recibos.
dia	d		integer	O dia na data difusa.
month	m		integer	O mês na data difusa.
ano	y		integer	O ano na data difusa.

Retornos

Taxa de participante criada

Corpo: EventApi.CreatedParticipantFee

Excluir um código constituinte

ID da operação:: DeleteConstituentCode

Exclui um código constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do código constituinte	constituent_code_id	True	string	A ID do registro do sistema do código constituinte a ser excluído.

Listar aliases constituintes

ID da operação:: ListConstituentAliases

Lista os aliases 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

Aliases

Corpo: ConstituentApi.ApiCollectionOfAliasRead

Listar anexos constituintes

ID da operação:: ListConstituentAttachments

Lista os anexos 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

Attachments

Corpo: ConstituentApi.ApiCollectionOfConstituentAttachmentRead

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 anexos de campanha

ID da operação:: ListCampaignAttachments

Lista os anexos de uma campanha.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da Campanha	campaign_id	True	string	A ID de registro do sistema da campanha.

Retornos

Attachments

Corpo: FundraisingApi.ApiCollectionOfCampaignAttachmentRead

Listar anexos de fundos

ID da operação:: ListFundAttachments

Lista os anexos de um fundo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do fundo	fund_id	True	string	A ID do registro do sistema do fundo.

Retornos

Attachments

Corpo: FundraisingApi.ApiCollectionOfFundAttachmentRead

Listar anexos de oportunidade

ID da operação:: ListOpportunityAttachments

Lista os anexos para uma oportunidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da oportunidade	opportunity_id	True	string	A ID de registro do sistema da oportunidade.

Retornos

Attachments

Corpo: OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

Listar anexos de presentes

ID da operação:: ListGiftAttachments

Lista os anexos de um presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do presente	gift_id	True	string	A ID do registro do sistema do presente.

Retornos

Attachments

Corpo: GiftApi.ApiCollectionOfGiftAttachmentRead

Listar anexos de recurso

ID da operação:: ListAppealAttachments

Lista os anexos de um recurso.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de recurso	appeal_id	True	string	A ID do registro do sistema do recurso.

Retornos

Attachments

Corpo: FundraisingApi.ApiCollectionOfAppealAttachmentRead

Listar anotações constituintes

ID da operação:: ListConstituentNotes

Lista as anotaçõ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

Anotações

Corpo: ConstituentApi.ApiCollectionOfNoteRead

Listar arrecadações de fundos constituintes

ID da operação:: ListConstituentFundraiserAssignments

Lista as atribuições de arrecadação de fundos para 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.
Incluir inativo?	include_inactive		boolean	Incluir atribuições inativas de arrecadação de fundos?

Retornos

Atribuições de arrecadação de fundos

Corpo: ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Listar atribuições de arrecadação de fundos

ID da operação:: ListFundraiserAssignments

Liste as tarefas para uma arrecadação de fundos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da arrecadação de fundos	fundraiser_id	True	string	A ID do registro do sistema da arrecadação de fundos para quem as atribuições devem ser retornadas.
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.

Retornos

Assignments

Corpo: FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

Listar ações

ID da operação:: ListActions

Retorna uma lista de ações.

Parâmetros

Nome	Chave	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 campanhas

ID da operação:: ListCampaigns

Retorna uma lista de campanhas.

Parâmetros

Nome	Chave	Tipo	Description
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.
Incluir inativo?	include_inactive	boolean	Incluir campanhas inativas?
Adicionado em ou após	date_added	date-time	Filtre os resultados para campanhas 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 campanhas modificadas na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Retornos

Campaigns

Corpo: FundraisingApi.ApiCollectionOfCampaignRead

Listar campos personalizados constituintes

ID da operação:: ListConstituentCustomFields

Lista os campos personalizados para 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

Campos Personalizados

Corpo: ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

Listar campos personalizados da campanha

ID da operação:: ListCampaignCustomFields

Lista os campos personalizados para uma campanha.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da Campanha	campaign_id	True	string	A ID de registro do sistema da campanha.

Retornos

Campos Personalizados

Corpo: FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

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

Listar campos personalizados de oportunidade

ID da operação:: ListOpportunityCustomFields

Lista os campos personalizados para uma oportunidade.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da oportunidade	opportunity_id	True	string	A ID de registro do sistema da oportunidade.

Retornos

Campos Personalizados

Corpo: OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

Listar campos personalizados de presentes

ID da operação:: ListGiftCustomFields

Lista os campos personalizados para um presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do presente	gift_id	True	string	A ID do registro do sistema do presente.

Retornos

Campos Personalizados

Corpo: GiftApi.ApiCollectionOfGiftCustomFieldRead

Listar campos personalizados de recurso

ID da operação:: ListAppealCustomFields

Lista os campos personalizados para um recurso.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de recurso	appeal_id	True	string	A ID do registro do sistema do recurso.

Retornos

Campos Personalizados

Corpo: FundraisingApi.ApiCollectionOfAppealCustomFieldRead

Listar campos personalizados do fundo

ID da operação:: ListFundCustomFields

Lista os campos personalizados para um fundo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do fundo	fund_id	True	string	A ID do registro do sistema do fundo.

Retornos

Campos Personalizados

Corpo: FundraisingApi.ApiCollectionOfFundCustomFieldRead

Listar classificações constituintes

ID da operação:: ListConstituentRatings

Retorna a lista de classificações para 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
Incluir inativo?	include_inactive		boolean	Incluir classificações inativas?
Só mais recente?	most_recent_only		boolean	Incluir apenas as classificações mais recentes?

Retornos

Avaliações

Corpo: ConstituentApi.ApiCollectionOfRatingRead

Listar constituintes

ID da operação:: ListConstituents

Retorna uma lista de constituintes.

Parâmetros

Nome	Chave	Tipo	Description
List	list_id	string	Define um identificador de lista usado para filtrar o conjunto de constituintes para aqueles incluídos na lista especificada. Se esse valor for definido, outros filtros especificados serão ignorados.
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.
Código constituinte	constituent_code	string	Representa um código constituinte para filtrar a lista. Por exemplo, "Membro do Conselho" retorna somente os constituintes com um código constituinte membro do conselho.
ID do Constituinte	constituent_id	string	Representa uma lista separada por vírgulas de identificadores constituintes para filtrar os resultados. Por exemplo, "280.1232" retorna apenas o constituinte 280 ou o constituinte 1232.
Categoria de campo personalizado	custom_field_category	string	Representa uma categoria de campo personalizada para filtrar os resultados. Por exemplo, "Aniversário" retorna somente os constituintes com um campo personalizado de Aniversário ativo.
Status da arrecadação de fundos	fundraiser_status	string	Representa uma lista separada por vírgulas de status de arrecadação de fundos para filtrar os resultados. Por exemplo, "Ativo, Nenhum" retorna apenas os eleitores cujo status de arrecadação de fundos é Ativo ou Nenhum. Os valores válidos para esse filtro são Ativo, Inativo e Nenhum.
Incluir falecido?	include_deceased	boolean	Incluir eleitores falecidos na resposta?
Incluir inativo?	include_inactive	boolean	Incluir componentes inativos na resposta?
CEP	postal_code	string	Representa uma lista separada por vírgulas de códigos postais para filtrar os resultados. Por exemplo, "29466,29492" retorna apenas os constituintes cujo endereço preferencial tem um código postal que começa com 29466 ou 29492, como 29466, 29492 ou 29492-0727.
Adicionado em ou após	date_added	date-time	Filtre os resultados para os constituintes criados 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 os constituintes modificados na data especificada (por exemplo: '2020-09-18T04:13:56Z').
Classificado por	sort	string	Representa uma lista de campos para classificar os resultados. Os resultados estão em ordem crescente por padrão e um sinal '-' indica ordem decrescente. Por exemplo, "date_added,-last" classifica os constituintes pelo campo "date_added" em ordem crescente e, em seguida, pelo campo "último" em ordem decrescente.

Retornos

Constituintes

Corpo: ConstituentApi.ApiCollectionOfConstituentRead

Listar códigos constituintes

ID da operação:: ListConstituentCodes

Lista os códigos constituintes para 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

Códigos constituintes

Corpo: ConstituentApi.ApiCollectionOfConstituentCodeRead

Listar códigos de solicitação constituintes

ID da operação:: ListConstituentSolicitCodes

Lista os códigos de solicitação para 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

Solicitar códigos

Corpo: CommPrefApi.ConstituentSolicitCodeReadCollection

Listar doações de participantes

ID da operação:: ListParticipantDonations

Lista as doações para um participante.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do participante	participant_id	True	string	A ID do registro do sistema do participante.
Limit	limit		integer	Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.
Offset	offset		integer	Representa o número de registros a serem ignoradas. Para uso com paginação. O padrão é 0.

Retornos

Doações

Corpo: EventApi.ApiCollectionOfParticipantDonation

Listar educaçãos constituintes

ID da operação:: ListConstituentEducations

Lista os registros de educação 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

Educações

Corpo: ConstituentApi.ApiCollectionOfEducationRead

Listar endereços constituintes

ID da operação:: ListConstituentAddresses

Lista os endereços 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.
Incluir inativo?	include_inactive		boolean	Incluir endereços inativos?

Retornos

Addresses

Corpo: ConstituentApi.ApiCollectionOfAddressRead

Listar endereços de email constituintes

ID da operação:: ListConstituentEmailAddresses

Lista os endereços de email 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.
Incluir inativo?	include_inactive		boolean	Incluir endereços de email inativos?

Retornos

Endereços de email

Corpo: ConstituentApi.ApiCollectionOfEmailAddressRead

Listar eventos

ID da operação:: ListEvents

Retorna uma lista de eventos.

Parâmetros

Nome	Chave	Tipo	Description
Categoria	category	string	Filtrar com base na categoria de evento.
Data de início a partir de	start_date_from	date	Filtre os resultados para eventos com data de início ativada ou após a data especificada (por exemplo: '2020-09-18').
Data de início para	start_date_to	date	Filtre os resultados para eventos com data de início em ou antes da data especificada (por exemplo: '2020-09-18').
Incluir inativo?	include_inactive	boolean	Incluir eventos inativos?
Limit	limit	integer	Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.
Offset	offset	integer	Representa o número de registros a serem ignoradas. Para uso com paginação.
ID do evento	event_id	string	Filtre os eventos que correspondem à ID de registro do sistema especificada.
Nome	name	string	Filtro para eventos que correspondem ao nome especificado.
Adicionado em ou após	date_added	date-time	Filtre os resultados para eventos criados 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 eventos modificados na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Retornos

Eventos

Corpo: EventApi.ApiCollectionOfEventListEntry

Listar fundos

ID da operação:: ListFunds

Retorna uma lista de fundos.

Parâmetros

Nome	Chave	Tipo	Description
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.
Incluir inativo?	include_inactive	boolean	Incluir fundos inativos?
Adicionado em ou após	date_added	date-time	Filtre os resultados para fundos criados 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 fundos modificados na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Retornos

Fundos

Corpo: FundraisingApi.ApiCollectionOfFundRead

Listar lotes de presentes

ID da operação:: ListGiftBatches

Liste os lotes de presentes.

Parâmetros

Nome	Chave	Tipo	Description
Número do lote	batch_number	string	Representa um filtro para resultados que correspondem ao número especificado.
Aprovado?	approved	boolean	Representa um filtro para o status do lote de presentes.
Tem exceções?	has_exceptions	boolean	Representa um filtro para saber se o lote de presentes contém exceções.
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.
Pesquisar texto	search_text	string	Representa um filtro para o texto incluído nos campos de descrição do lote ou número de lote.
Criado por	created_by	string	Representa um filtro para lotes de presentes criados pelo usuário especificado.

Retornos

Lotes de presentes

Corpo: GiftBatchApi.ApiCollectionOfGiftBatch

Listar oportunidades

ID da operação:: ListOpportunities

Retorna uma lista de oportunidades.

Parâmetros

Nome	Chave	Tipo	Description
List	list_id	string	Define um identificador de lista usado para filtrar o conjunto de oportunidades para aqueles incluídos na lista especificada. Se esse valor for definido, outros filtros especificados serão ignorados.
ID do Constituinte	constituent_id	string	Representa uma lista separada por vírgulas de identificadores constituintes para filtrar os resultados. Por exemplo, "280.1232" retorna apenas oportunidades do constituinte 280 ou constituinte 1232.
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.
Incluir inativo?	include_inactive	boolean	Incluir oportunidades inativas?
Adicionado em ou após	date_added	date-time	Filtre os resultados para oportunidades criadas na data especificada (por exemplo: '2020-09-18T04:13:56Z').
Modificado em ou após	last_modified	date-time	Filtre os resultados para oportunidades modificadas na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Retornos

Oportunidades

Corpo: OpportunityApi.ApiCollectionOfOpportunityRead

Listar opções de participantes do evento

ID da operação:: ListEventParticipantOptions

Lista as opções de participante para um evento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do evento	event_id	True	string	A ID do evento.

Retornos

Opções do participante do evento

Corpo: EventApi.ApiCollectionOfEventParticipantOption

Listar pacotes

ID da operação:: ListPackages

Retorna uma lista de pacotes.

Parâmetros

Nome	Chave	Tipo	Description
ID de recurso	appeal_id	string	Representa uma lista separada por vírgulas de identificadores de recurso para filtrar os resultados. Por exemplo, "506.918" retorna apenas pacotes para recurso 506 ou recurso 918.
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.
Incluir inativo?	include_inactive	boolean	Incluir pacotes inativos?
Adicionado em ou após	date_added	date-time	Filtre os resultados para pacotes criados 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 pacotes modificados na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Retornos

Packages

Corpo: FundraisingApi.ApiCollectionOfPackageRead

Listar pagamentos de taxa de participante

ID da operação:: ListParticipantFeePayments

Lista os pagamentos de taxa para um participante.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do participante	participant_id	True	string	A ID do registro do sistema do participante.
Limit	limit		integer	Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.
Offset	offset		integer	Representa o número de registros a serem ignoradas. Para uso com paginação. O padrão é 0.

Retornos

Pagamentos de taxas

Corpo: EventApi.ApiCollectionOfParticipantFeePayment

Listar participantes do evento

ID da operação:: ListEventParticipants

Lista os participantes de um evento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do evento	event_id	True	string	A ID do registro do sistema do evento.
Status do RSVP	rsvp_status		string	Filtrar participantes com base no status RSVP.
Status do convite	invitation_status		string	Filtrar participantes com base no status do convite.
Nível de participação	participation_level		string	Filtrar participantes com base no nível de envolvimento.
Participou?	attended_filter		boolean	Filtrar para incluir ou excluir participantes marcados como atendidos.
Taxas pagas?	fees_paid_filter		boolean	Filtrar para incluir ou excluir participantes que pagaram suas taxas.
Limit	limit		integer	Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.
Offset	offset		integer	Representa o número de registros a serem ignoradas. Para uso com paginação.
É um constituinte?	is_constituent_filter		boolean	Filtrar para incluir ou excluir participantes que são constituintes.
Tem um email qualificado?	email_eligible_filter		boolean	Filtrar para incluir ou excluir participantes com base em se eles têm um endereço de email primário que não está marcado Não enviar email?
Tem um telefone qualificado?	phone_call_eligible_filter		boolean	Filtrar para incluir ou excluir participantes com base em se eles têm um número de telefone primário que não está marcado Não ligue.
Nome	name		string	Filtro para participantes que correspondem ao nome especificado.
Adicionado em ou após	date_added		date-time	Filtre os resultados para os participantes criados 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 os participantes modificados na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Retornos

Participantes

Corpo: EventApi.ApiCollectionOfParticipantListEntry

Listar presentes

ID da operação:: ListGifts

Retorna uma lista de presentes.

Parâmetros

Nome	Chave	Tipo	Description
List	list_id	string	Define um identificador de lista usado para filtrar o conjunto de presentes para aqueles incluídos na lista especificada. Se esse valor for definido, outros filtros especificados serão ignorados.
Tipo	gift_type	string	Representa uma lista separada por vírgulas de tipos de presentes para filtrar os resultados. Por exemplo, "MatchingGiftPledge,RecurringGift" retorna apenas presentes do tipo MatchingGiftPledge ou RecurringGift.
ID do Constituinte	constituent_id	string	Representa uma lista separada por vírgulas de identificadores constituintes para filtrar os resultados. Por exemplo, "280.1232" retorna apenas presentes do constituinte 280 ou constituinte 1232.
ID da Campanha	campaign_id	string	Representa uma lista separada por vírgulas de identificadores de campanha para filtrar os resultados. Por exemplo, "506.918" retorna apenas presentes para a campanha 506 ou a campanha 918.
ID do fundo	fund_id	string	Representa uma lista separada por vírgulas de identificadores de fundos para filtrar os resultados. Por exemplo, "506.918" retorna apenas presentes para financiar 506 ou financiar 918.
ID de recurso	appeal_id	string	Representa uma lista separada por vírgulas de identificadores de recurso para filtrar os resultados. Por exemplo, "506.918" retorna apenas presentes para apelar 506 ou apelar 918.
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.
Data de início do presente	start_gift_date	date-time	Representa um filtro para presentes com uma data de presente na data especificada (por exemplo: '2020-09-18T04:13:56Z').
Data de término do presente	end_gift_date	date-time	Representa um filtro para presentes com uma data de presente em ou antes da data especificada (por exemplo: '2020-09-18T04:13:56Z').
Inicie o valor do presente	start_gift_amount	double	Representa um filtro para presentes com uma quantidade maior ou igual à quantidade especificada.
Valor final do presente	end_gift_amount	double	Representa um filtro para presentes com uma quantidade menor ou igual à quantidade especificada.
Status da postagem	post_status	string	Representa uma lista separada por vírgulas de status de postagem de presentes para filtrar os resultados. Por exemplo, "DoNotPost,Posted" retorna apenas presentes marcados como DoNotPost ou Posted.
Status do recebimento	receipt_status	string	Representa uma lista separada por vírgulas de status de recebimento de presentes para filtrar os resultados. Por exemplo, "DoNotReceipt,Receipted" retorna apenas presentes marcados como DoNotReceipt ou Receipted.
Status de confirmação	acknowledgement_status	string	Representa uma lista separada por vírgulas de status de confirmação de presentes para filtrar os resultados. Por exemplo, "DoNotAcknowledge,Acknowledged" retorna apenas presentes marcados como DoNotAcknowledge ou Acknowledged.
Adicionado em ou após	date_added	date-time	Filtre os resultados para presentes criados 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 presentes modificados na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Retornos

Presentes

Corpo: GiftApi.ApiCollectionOfGiftRead

Listar presenças online constituintes

ID da operação:: ListConstituentOnlinePresences

Lista as presenças online 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.
Incluir inativo?	include_inactive		boolean	Incluir presenças online inativas?

Retornos

Presenças online

Corpo: ConstituentApi.ApiCollectionOfOnlinePresenceRead

Listar recursos

ID da operação:: ListAppeals

Retorna uma lista de recursos.

Parâmetros

Nome	Chave	Tipo	Description
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.
Incluir inativo?	include_inactive	boolean	Incluir recursos inativos?
Adicionado em ou após	date_added	date-time	Filtre os resultados para recursos criados 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 recursos modificados na data especificada (por exemplo: '2020-09-18T04:13:56Z').

Retornos

Contestações

Corpo: FundraisingApi.ApiCollectionOfAppealRead

Listar registros de consentimento do constituinte

ID da operação:: ListConstituentConsents

Lista os registros de consentimento 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.
Mais recente apenas?	most_recent_only		boolean	Incluir apenas os registros de consentimento mais recentes para cada combinação de categoria de canal na resposta?

Retornos

Registros de consentimento

Corpo: CommPrefApi.ConstituentConsentReadCollection

Listar relações constituintes

ID da operação:: ListConstituentRelationships

Lista as relaçõ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.
Limit	limit		integer	Representa o número de registros a serem retornados. O padrão é 500. Não há no máximo.
Offset	offset		integer	Representa o número de registros a serem ignoradas. Para uso com paginação.

Retornos

Relationships

Corpo: ConstituentApi.ApiCollectionOfRelationshipRead

Listar taxas de evento

ID da operação:: ListEventFees

Lista as taxas de um evento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do evento	event_id	True	string	A ID do registro do sistema do evento.

Retornos

Taxas

Corpo: EventApi.ApiCollectionOfEventFee

Listar taxas de participantes

ID da operação:: ListParticipantFees

Lista as taxas para um participante.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do participante	participant_id	True	string	A ID do registro do sistema do participante.
Limit	limit		integer	Representa o número de registros a serem retornados. O padrão é 500. O máximo é 10000.
Offset	offset		integer	Representa o número de registros a serem ignoradas. Para uso com paginação. O padrão é 0.

Retornos

Taxas

Corpo: EventApi.ApiCollectionOfParticipantFee

Listar telefones constituintes

ID da operação:: ListConstituentPhones

Lista os telefones 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.
Incluir inativo?	include_inactive		boolean	Incluir telefones inativos?

Retornos

Telefones

Corpo: ConstituentApi.ApiCollectionOfPhoneRead

Obter a concessão do tempo de vida do constituinte

ID da operação:: GetConstituentLifetimeGiving

Retorna o tempo de vida dando resumo para 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

Concessão de tempo de vida

Corpo: ConstituentApi.LifetimeGivingRead

Obter o maior presente constituinte

ID da operação:: GetConstituentGreatestGift

Retorna o maior presente para 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

Dando resumo

Corpo: ConstituentApi.GivingSummaryRead

Obter o primeiro presente constituinte

ID da operação:: GetConstituentFirstGift

Retorna o primeiro presente para 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

Dando resumo

Corpo: ConstituentApi.GivingSummaryRead

Obter o último presente constituinte

ID da operação:: GetConstituentLatestGift

Retorna o último presente para 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

Dando resumo

Corpo: ConstituentApi.GivingSummaryRead

Obter status de perspectiva constituinte

ID da operação:: GetConstituentProspectStatus

Retorna o status de perspectiva atual para 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 para o qual o status de perspectiva deve ser recuperado.

Retornos

Status de perspectiva

Corpo: ConstituentApi.ProspectStatusRead

Obter um constituinte

ID da operação:: GetConstituent

Retorna informações sobre um constituinte.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Constituinte	constituent_id	True	string	A ID de registro do sistema do constituinte a ser obtido.

Retornos

Constituinte

Corpo: ConstituentApi.ConstituentRead

Obter um evento

ID da operação:: GetEvent

Retorna informações sobre um evento.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do evento	event_id	True	string	A ID do registro do sistema do evento a ser obtido.

Retornos

Event

Corpo: EventApi.Event

Obter um fundo

ID da operação:: GetFund

Retorna informações sobre um fundo.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do fundo	fund_id	True	string	A ID do registro do sistema do fundo a ser obtido.

Retornos

Fundo

Corpo: FundraisingApi.FundRead

Obter um pacote

ID da operação:: GetPackage

Retorna informações sobre um pacote.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do Pacote	package_id	True	string	A ID do registro do sistema do pacote a ser obtido.

Retornos

Package

Corpo: FundraisingApi.PackageRead

Obter um participante

ID da operação:: GetParticipant

Retorna informações sobre um participante de evento específico.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do participante	participant_id	True	string	A ID do registro do sistema do participante.

Retornos

Participante

Corpo: EventApi.Participant

Obter um presente

ID da operação:: GetGift

Retorna informações sobre um presente.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do presente	gift_id	True	string	A ID do registro do sistema do presente a ser obtido.

Retornos

Presente

Corpo: GiftApi.GiftRead

Obter um recurso

ID da operação:: GetAppeal

Retorna informações sobre um recurso.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID de recurso	appeal_id	True	string	A ID do registro do sistema do recurso a ser obtido.

Retornos

Appeal

Corpo: FundraisingApi.AppealRead

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

Obter uma campanha

ID da operação:: GetCampaign

Retorna informações sobre uma campanha.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da Campanha	campaign_id	True	string	A ID de registro do sistema da campanha a ser obtido.

Retornos

Campanha

Corpo: FundraisingApi.CampaignRead

Obter uma imagem de perfil constituinte

ID da operação:: GetConstituentProfilePicture

Retorna a imagem de perfil atual 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 para o qual a imagem de perfil deve ser recuperada.

Retornos

Imagem do perfil

Corpo: ConstituentApi.ProfilePictureRead

Obter uma oportunidade

ID da operação:: GetOpportunity

Retorna informações sobre uma oportunidade. Observação: esse ponto de extremidade retorna a propriedade de status com uma latência de cerca de 10 minutos.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID da oportunidade	opportunity_id	True	string	A ID de registro do sistema da oportunidade de obter.

Retornos

Oportunidade

Corpo: OpportunityApi.OpportunityRead

Opções de participante de lista

ID da operação:: ListParticipantOptions

Lista as opções de participante para um participante.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
ID do participante	participant_id	True	string	A ID do registro do sistema do participante.

Retornos

Opções de participante

Corpo: EventApi.ApiCollectionOfParticipantOption

Pesquisar um constituinte

ID da operação:: SearchConstituent

Executa uma pesquisa constituinte com base no texto de pesquisa fornecido. Dá suporte ao nome, sobrenome, nome preferencial, nome antigo, alias, endereço de email, número de telefone, endereço ou ID de pesquisa. Combinações de nomes como nome e sobrenome ou nome preferencial e sobrenome são válidas, mas caso contrário, a pesquisa só dá suporte a um parâmetro de cada vez. Por padrão, as pesquisas incluem resultados que soam semelhantes aos seus critérios. Por exemplo, as pesquisas por "Smith" incluem correspondências para "Smyth" e outras ortografias alternativas. Essa pesquisa não dá suporte a caracteres curinga como * ou ?. Os resultados da pesquisa são limitados a 500 registros.

Parâmetros

Nome	Chave	Obrigatório	Tipo	Description
Pesquisar texto	search_text	True	string	O texto da pesquisa. Dá suporte ao nome, sobrenome, nome preferencial, nome antigo, alias, endereço de email, número de telefone, endereço ou ID de pesquisa. Combinações de nomes como nome e sobrenome ou nome preferencial e sobrenome são válidas, mas caso contrário, a pesquisa só dá suporte a um parâmetro de cada vez. Por padrão, as pesquisas incluem resultados que soam semelhantes aos seus critérios. Por exemplo, as pesquisas por "Smith" incluem correspondências para "Smyth" e outras ortografias alternativas. Essa pesquisa não dá suporte a caracteres curinga como * ou ?. Os resultados da pesquisa são limitados a 500 registros.
Status da arrecadação de fundos	fundraiser_status		string	Representa uma lista separada por vírgulas de status de arrecadação de fundos para filtrar os resultados. Por exemplo, "Ativo, Nenhum" retorna apenas os eleitores cujo status de arrecadação de fundos é Ativo ou Nenhum. Os valores válidos para esse filtro são Ativo, Inativo e Nenhum.
Incluir inativo?	include_inactive		boolean	Incluir componentes inativos na resposta?
Campo de pesquisa	search_field		string	Representa um campo no qual pesquisar. Atualmente, ele só dá suporte a lookup_id. Se for fornecido com search_text, um constituinte com lookup_id que corresponda ao search_text será retornado.
Usar uma pesquisa estrita?	strict_search		boolean	Excluir constituintes cujos nomes soam como o texto de pesquisa, mas são escritos de forma diferente?
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.

Retornos

Resultados da pesquisa

Corpo: ConstituentApi.ApiCollectionOfSearchResultRead

Definições

CommPrefApi.ConstituentConsentRead

Representa uma entidade de consentimento para um constituinte.

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do registro de consentimento.
Channel	channel	string	O canal ao qual a resposta de consentimento se aplica.
Categoria	category	string	A categoria à qual a resposta de consentimento se aplica.
Source	source	string	A origem da resposta de consentimento do constituinte.
Resposta	constituent_consent_response	string	Como o constituinte respondeu ao consentimento do canal/categoria especificado.
Date	consent_date	date-time	A data em que a resposta de consentimento foi recebida.
Instrução de consentimento	consent_statement	string	A declaração à qual o constituinte respondeu ao fornecer consentimento.
Aviso de privacidade	privacy_notice	string	O aviso de privacidade fornecido ao constituinte.
Data de inclusão	date_added	date-time	A data em que a resposta de consentimento foi adicionada.
Adicionado por	user_name	string	O usuário que adicionou a resposta de consentimento.

CommPrefApi.ConstituentConsentReadCollection

Registros de consentimento

Nome	Caminho	Tipo	Description
Contagem	count	integer	O número de registros de consentimento na lista.
value	value	array of CommPrefApi.ConstituentConsentRead	O conjunto de registros de consentimento incluído na resposta.

CommPrefApi.ConstituentSolicitCodeRead

Solicitar código

Nome	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema do código de solicitação constituinte.
Solicitar código	solicit_code	string	Instruções de comunicação e/ou restrições para um constituinte.
Data de início	start_date	date	A data de início do código de solicitação (por exemplo: '2005-09-18').
Data de término	end_date	date	A data de término do código de solicitação (por exemplo: '2005-09-18').

CommPrefApi.ConstituentSolicitCodeReadCollection

Solicitar códigos

Nome	Caminho	Tipo	Description
Contagem	count	integer	O número de códigos de solicitação constituintes na lista.
value	value	array of CommPrefApi.ConstituentSolicitCodeRead	O conjunto de códigos de solicitação constituintes incluídos na resposta.

CommPrefApi.CreatedConstituentConsent

Consentimento constituinte criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro de consentimento recém-criado.

CommPrefApi.CreatedConstituentSolicitCode

Código de solicitação constituinte criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do código de solicitação constituinte recém-criado.

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.

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.
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.AddressRead

Endereço

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do endereço.
Tipo	type	string	O tipo de endereço.
País	country	string	O país do endereço (pode ser a ID, o nome ou a abreviação).
Linhas de endereço	address_lines	string	As linhas de endereço.
City	city	string	A cidade do endereço (não use em combinação com o campo Subúrbio).
Estado	state	string	O estado do endereço.
CEP	postal_code	string	O código postal do endereço.
Subúrbio	suburb	string	O subúrbio do endereço (não use em combinação com o campo Cidade).
Município	county	string	A região do endereço.
Endereço formatado	formatted_address	string	O endereço formatado no formato configurado do país.
Fonte de informações	information_source	string	A fonte de informações do endereço.
Região	region	string	A região do endereço.
CARROÇA	cart	string	A rota da transportadora (CART) para o endereço.
LOTE	lot	string	A linha de viagem (LOT) para o endereço.
DPC	dpc	string	O código do ponto de entrega (DPC) para o endereço.
Válido a partir de	start	date-time	A data em que o constituinte começou a residir neste endereço.
Válida até	end	date-time	A data em que o constituinte deixou de residir neste endereço.
Primário?	preferred	boolean	Este é o endereço preferencial do constituinte?
Inativo?	inactive	boolean	O endereço está inativo (ou seja, a data atual é antes de qualquer data de término)?
Não enviar emails?	do_not_mail	boolean	O constituinte pode ser contatado neste endereço?
dia	seasonal_start.d	integer	O dia na data difusa.
month	seasonal_start.m	integer	O mês na data difusa.
ano	seasonal_start.y	integer	O ano na data difusa.
dia	seasonal_end.d	integer	O dia na data difusa.
month	seasonal_end.m	integer	O mês na data difusa.
ano	seasonal_end.y	integer	O ano na data difusa.
Data de inclusão	date_added	date-time	A data em que o endereço foi criado.
Data modificada	date_modified	date-time	A data em que o endereço foi modificado pela última vez.

ConstituentApi.AliasRead

Alias

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do alias.
Alias	name	string	O nome a ser usado como alias do constituinte.
Tipo	type	string	O tipo de alias.

ConstituentApi.ApiCollectionOfAddressRead

Addresses

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.AddressRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

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.ApiCollectionOfAliasRead

Aliases

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.AliasRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfConstituentAttachmentRead

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.ConstituentAttachmentRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfConstituentCodeRead

Códigos constituintes

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.ConstituentCodeRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfConstituentCustomFieldRead

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.ConstituentCustomFieldRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfConstituentRead

Constituintes

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.ConstituentRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfEducationRead

Educaçõ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.EducationRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfEmailAddressRead

Endereços de email

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.EmailAddressRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfFundraiserAssignmentRead

Atribuições de arrecadação de fundos

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.FundraiserAssignmentRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfNoteRead

Anotaçõ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.NoteRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfOnlinePresenceRead

Presenças online

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.OnlinePresenceRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfPhoneRead

Telefones

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.PhoneRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfRatingRead

Avaliaçõ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.RatingRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfRelationshipRead

Relationships

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.RelationshipRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.ApiCollectionOfSearchResultRead

Resultados da pesquisa

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.SearchResultRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

ConstituentApi.AppealRead

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do recurso.
descrição	description	string	A descrição do recurso.

ConstituentApi.CampaignRead

Nome	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema da campanha.
descrição	description	string	A descrição da campanha.

ConstituentApi.ConstituentAttachmentRead

Anexo

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do anexo.
ID do Constituinte	parent_id	string	A ID do registro do sistema do constituinte associado 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.

ConstituentApi.ConstituentCodeRead

Código constituinte

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do código constituinte.
ID do Constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado ao código constituinte.
Código constituinte	description	string	O código constituinte.
dia	start.d	integer	O dia na data difusa.
month	start.m	integer	O mês na data difusa.
ano	start.y	integer	O ano na data difusa.
dia	end.d	integer	O dia na data difusa.
month	end.m	integer	O mês na data difusa.
ano	end.y	integer	O ano na data difusa.
Inativo?	inactive	boolean	O código constituinte está inativo?
Sequence	sequence	integer	A sequência numérica associada ao código constituinte.
Data de inclusão	date_added	date-time	A data em que o código constituinte foi criado.
Data modificada	date_modified	date-time	A data em que o código constituinte foi modificado pela última vez.

ConstituentApi.ConstituentCustomFieldRead

Campo personalizado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do campo personalizado.
ID do Constituinte	parent_id	string	A ID do registro do sistema do constituinte associado 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.
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.ConstituentRead

Constituinte

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema para o constituinte. Isso não é o mesmo que o identificador de constituinte definível pelo usuário, que é armazenado no lookup_id.
Tipo	type	string	O tipo de constituinte.
Title	title	string	O título primário do constituinte (somente para indivíduos).
Nome	first	string	O nome do constituinte (somente para indivíduos).
Sobrenome	last	string	O sobrenome do constituinte (somente para indivíduos).
Nome	name	string	Para indivíduos, esse campo é o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino. Para organizações, esse é o nome da organização.
Nome preferencial	preferred_name	string	O nome preferencial do constituinte (somente para indivíduos).
Sufixo	suffix	string	O sufixo primário do constituinte (somente para indivíduos).
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o constituinte.
ID	email.id	string	A ID do registro do sistema do endereço de email.
tipo	email.type	string	O tipo de endereço de email.
address	email.address	string	O endereço de email.
não enviar email?	email.do_not_email	boolean	O constituinte pode ser contatado neste endereço de email?
inativo?	email.inactive	boolean	Esse endereço de email está inativo?
data adicionada	email.date_added	date-time	A data em que o endereço de email foi criado.
data modificada	email.date_modified	date-time	A data em que o endereço de email foi modificado pela última vez.
ID	phone.id	string	A ID do registro do sistema do telefone.
tipo	phone.type	string	O tipo de telefone.
número	phone.number	string	O número de telefone.
não ligar?	phone.do_not_call	boolean	O constituinte pode ser contatado neste número?
inativo?	phone.inactive	boolean	Esse número de telefone está inativo?
data adicionada	phone.date_added	date-time	A data em que o telefone foi criado.
data modificada	phone.date_modified	date-time	A data em que o telefone foi modificado pela última vez.
ID	online_presence.id	string	A ID do registro do sistema da presença online.
tipo	online_presence.type	string	O tipo de presença online.
link	online_presence.address	string	O endereço da Web para a presença online.
inativo?	online_presence.inactive	boolean	Essa presença online está inativa?
data adicionada	online_presence.date_added	date-time	A data em que a presença online foi criada.
data modificada	online_presence.date_modified	date-time	A data em que a presença online foi modificada pela última vez.
ID	address.id	string	A ID do registro do sistema do endereço.
tipo	address.type	string	O tipo de endereço.
country	address.country	string	O país do endereço (pode ser a ID, o nome ou a abreviação).
Linhas	address.address_lines	string	As linhas de endereço.
city	address.city	string	A cidade do endereço (não use em combinação com o campo Subúrbio).
estado	address.state	string	O estado do endereço.
código postal	address.postal_code	string	O código postal do endereço.
subúrbio	address.suburb	string	O subúrbio do endereço (não use em combinação com o campo Cidade).
condado	address.county	string	A região do endereço.
Formatado	address.formatted_address	string	O endereço formatado no formato configurado do país.
válido de	address.start	date-time	A data em que o constituinte começou a residir neste endereço.
válido para	address.end	date-time	A data em que o constituinte deixou de residir neste endereço.
inativo?	address.inactive	boolean	O endereço está inativo (ou seja, a data atual é antes de qualquer data de término)?
não enviar emails?	address.do_not_mail	boolean	O constituinte pode ser contatado neste endereço?
dia	address.seasonal_start.d	integer	O dia na data difusa.
month	address.seasonal_start.m	integer	O mês na data difusa.
ano	address.seasonal_start.y	integer	O ano na data difusa.
dia	address.seasonal_end.d	integer	O dia na data difusa.
month	address.seasonal_end.m	integer	O mês na data difusa.
ano	address.seasonal_end.y	integer	O ano na data difusa.
data adicionada	address.date_added	date-time	A data em que o endereço foi criado.
data modificada	address.date_modified	date-time	A data em que o endereço foi modificado pela última vez.
Gênero	gender	string	O gênero do constituinte (somente para indivíduos).
Nome do meio	middle	string	O nome do meio do constituinte (somente para indivíduos).
Nome antigo	former_name	string	O nome antigo do constituinte (somente para indivíduos).
Título 2	title_2	string	O título secundário do constituinte (somente para indivíduos).
Sufixo 2	suffix_2	string	O sufixo secundário do constituinte (somente para indivíduos).
Staus conjugal	marital_status	string	O estado civil do constituinte (somente para indivíduos).
Dá anonimamente?	gives_anonymously	boolean	O constituinte dá anonimamente?
Inativo?	inactive	boolean	O constituinte está inativo?
dia	birthdate.d	integer	O dia na data difusa.
month	birthdate.m	integer	O mês na data difusa.
ano	birthdate.y	integer	O ano na data difusa.
Terra natal	birthplace	string	O local de nascimento do constituinte (somente para indivíduos).
Etnia	ethnicity	string	A etnia do constituinte (somente para indivíduos).
Rendimento	income	string	A renda do constituinte (somente para pessoas físicas).
Religião	religion	string	A religião do constituinte (somente para indivíduos).
Setor	industry	string	A indústria do constituinte (somente para organizações).
Número de funcionários	num_employees	integer	O número de funcionários da organização.
Corresponde a presentes?	matches_gifts	boolean	A organização corresponde a presentes?
Fator presente correspondente	matching_gift_factor	double	O fator presente correspondente (somente para organizações).
Correspondência mínima por presente	matching_gift_per_gift_min.value	double	A quantidade mínima de correspondência por presente para o constituinte (somente para organizações).
Correspondência máxima por presente	matching_gift_per_gift_max.value	double	A quantidade máxima de correspondência por presente para o constituinte (somente para organizações).
Correspondência mínima por constit	matching_gift_total_min.value	double	O total mínimo de correspondência para o constituinte (somente para organizações).
Correspondência máxima por constit	matching_gift_total_max.value	double	O total máximo de correspondências para o constituinte (somente para organizações).
Notas de presente correspondentes	matching_gift_notes	string	As notas de presente correspondentes para o constituinte (somente para organizações).
Idade	age	integer	A idade do constituinte, conforme calculado com base na propriedade de data de nascimento (somente para indivíduos).
Falecido?	deceased	boolean	O constituinte está falecido (somente para indivíduos)?
dia	deceased_date.d	integer	O dia na data difusa.
month	deceased_date.m	integer	O mês na data difusa.
ano	deceased_date.y	integer	O ano na data difusa.
Status da arrecadação de fundos	fundraiser_status	string	Indica se o constituinte é uma arrecadação de fundos (somente para indivíduos).
ID	spouse.id	string	A ID do registro do sistema do cônjuge.
nome próprio	spouse.first	string	O nome do cônjuge.
apelido	spouse.last	string	O sobrenome do cônjuge.
é o chefe da casa?	spouse.is_head_of_household	boolean	O cônjuge é o chefe da casa?
Data de inclusão	date_added	date-time	A data em que o constituinte foi criado.
Data modificada	date_modified	date-time	A data em que o constituinte foi modificado pela última vez.

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.

ConstituentApi.CreatedConstituentAddress

Endereço constituinte criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do endereço constituinte recém-criado.

ConstituentApi.CreatedConstituentAlias

Alias constituinte criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do alias constituinte recém-criado.

ConstituentApi.CreatedConstituentAttachment

Anexo constituinte criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do anexo constituinte recém-criado.

ConstituentApi.CreatedConstituentCode

Código constituinte criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do código constituinte recém-criado.

ConstituentApi.CreatedConstituentCustomField

Campo personalizado constituinte criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do campo personalizado constituinte recém-criado.

ConstituentApi.CreatedConstituentEducation

Educação constituinte criada

Nome	Caminho	Tipo	Description
ID	id	string	A ID da educação constituinte recém-criada.

ConstituentApi.CreatedConstituentEmailAddress

Endereço de email constituinte criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do endereço de email constituinte recém-criado.

ConstituentApi.CreatedConstituentNote

Anotação constituinte criada

Nome	Caminho	Tipo	Description
ID	id	string	A ID da nota constituinte recém-criada.

ConstituentApi.CreatedConstituentOnlinePresence

Presença online constituinte criada

Nome	Caminho	Tipo	Description
ID	id	string	A ID da presença online constituinte recém-criada.

ConstituentApi.CreatedConstituentPhone

Telefone constituinte criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do telefone constituinte recém-criado.

ConstituentApi.CreatedConstituentRating

Classificação constituinte criada

Nome	Caminho	Tipo	Description
ID	id	string	A ID da classificação constituinte recém-criada.

ConstituentApi.CreatedIndividualConstituent

Constituinte individual criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do constituinte individual recém-criado.

ConstituentApi.CreatedIndividualRelationship

Relação individual criada

Nome	Caminho	Tipo	Description
ID	id	string	A ID da relação individual recém-criada.

ConstituentApi.CreatedOrganizationConstituent

Constituinte da organização criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do constituinte da organização recém-criado.

ConstituentApi.CreatedOrganizationRelationship

Relação de organização criada

Nome	Caminho	Tipo	Description
ID	id	string	A ID da relação de organização recém-criada.

ConstituentApi.EducationRead

Educação

Nome	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema da educação.
ID do Constituinte	constituent_id	string	A ID de registro do sistema do constituinte associado à educação.
Escola	school	string	O nome da escola/estabelecimento.
Tipo	type	string	O tipo de educação.
Classe de	class_of	string	O ano em que o constituinte se formou.
Situação	status	string	O status da educação.
dia	date_entered.d	integer	O dia na data difusa.
month	date_entered.m	integer	O mês na data difusa.
ano	date_entered.y	integer	O ano na data difusa.
dia	date_left.d	integer	O dia na data difusa.
month	date_left.m	integer	O mês na data difusa.
ano	date_left.y	integer	O ano na data difusa.
dia	date_graduated.d	integer	O dia na data difusa.
month	date_graduated.m	integer	O mês na data difusa.
ano	date_graduated.y	integer	O ano na data difusa.
Grau	degree	string	O grau recebido.
GPA	gpa	double	A média de pontos de nota.
Majors	majors	array of string	Os principais cursos de estudo.
Menores	minors	array of string	Os cursos secundários de estudo.
O ensino fundamental é?	primary	boolean	Esta é a associação de escola primária do constituinte?
Campus	campus	string	O campus.
Organização social	social_organization	string	A organização social.
Nome conhecido	known_name	string	O nome conhecido.
Classe de grau	class_of_degree	string	A classe de grau.
Departamento	department	string	O nome do departamento de educação.
Faculdade	faculty	string	O nome da faculdade.
Número de registro	registration_number	string	O número do registro.
Assunto de estudo	subject_of_study	string	O assunto do estudo.
Data de inclusão	date_added	date-time	A data em que a educação foi criada.
Data modificada	date_modified	date-time	A data em que a educação foi modificada pela última vez.

ConstituentApi.EmailAddressRead

Endereço de email

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do endereço de email.
ID do Constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado ao endereço de email.
Tipo de email	type	string	O tipo de endereço de email.
Endereço de email	address	string	O endereço de email.
Primário?	primary	boolean	Este é o endereço de email principal do constituinte?
Não enviar email?	do_not_email	boolean	O constituinte pode ser contatado neste endereço de email?
Inativo?	inactive	boolean	Esse endereço de email está inativo?
Data de inclusão	date_added	date-time	A data em que o endereço de email foi criado.
Data modificada	date_modified	date-time	A data em que o endereço de email foi modificado pela última vez.

ConstituentApi.FileDefinition

Definição de arquivo

Nome	Caminho	Tipo	Description
ID de Arquivo	file_id	string	O identificador do arquivo.
URL	file_upload_request.url	string	A URL a ser usada para a solicitação de upload.
método	file_upload_request.method	string	O método HTTP a ser usado com a solicitação de upload.
headers	file_upload_request.headers	array of ConstituentApi.Header	Os cabeçalhos a serem fornecidos ao fazer a solicitação.
ID da miniatura	thumbnail_id	string	O identificador da miniatura.
URL	thumbnail_upload_request.url	string	A URL a ser usada para a solicitação de upload.
método	thumbnail_upload_request.method	string	O método HTTP a ser usado com a solicitação de upload.
headers	thumbnail_upload_request.headers	array of ConstituentApi.Header	Os cabeçalhos a serem fornecidos ao fazer a solicitação.

ConstituentApi.FundraiserAssignmentRead

Atribuição de arrecadação de fundos

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema da tarefa de arrecadação de fundos.
ID do Constituinte	constituent_id	string	A ID do registro do sistema do constituinte atribuída à arrecadação de fundos.
ID da arrecadação de fundos	fundraiser_id	string	A ID do registro do sistema da arrecadação de fundos.
Tipo	type	string	O tipo de arrecadação de fundos.
value	amount.value	double	O valor monetário.
ID da Campanha	campaign_id	string	A ID de registro do sistema da campanha à qual aplicar presentes resultantes.
ID do fundo	fund_id	string	A ID de registro do sistema do fundo a que os presentes resultantes devem ser aplicados. Se um fundo restrito for selecionado, somente campanhas e recursos associados a esse fundo poderão ser selecionados.
ID de recurso	appeal_id	string	A ID do registro do sistema do recurso que a arrecadação de fundos deve usar para solicitar presentes.
Data de início	start	date-time	A data de início da tarefa de arrecadação de fundos.
Data de término	end	date-time	A data de término da tarefa de arrecadação de fundos.

ConstituentApi.FundRead

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do fundo.
descrição	description	string	A descrição do fundo.

ConstituentApi.GivingSummaryRead

Dando resumo

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do presente.
Tipo	type	string	O tipo de presente.
Date	date	date-time	A data do presente.
value	amount.value	double	O valor monetário.
Appeal	appeals	array of ConstituentApi.AppealRead	O conjunto de apelos associados ao presente.
Campanha	campaigns	array of ConstituentApi.CampaignRead	O conjunto de campanhas associadas ao presente.
Fundo	funds	array of ConstituentApi.FundRead	O conjunto de fundos associados ao presente.

Cabeçalho de solicitação usado para carregar o anexo físico.

Nome	Caminho	Tipo	Description
nome	name	string	O nome do cabeçalho.
value	value	string	O valor do cabeçalho.

ConstituentApi.LifetimeGivingRead

Concessão de tempo de vida

Nome	Caminho	Tipo	Description
Anos consecutivos dados	consecutive_years_given	integer	O número de anos consecutivos que o constituinte deu.
Total de anos dados	total_years_given	integer	O número total de anos que o constituinte deu.
value	total_giving.value	double	O valor monetário.
value	total_pledge_balance.value	double	O valor monetário.
value	total_received_giving.value	double	O valor monetário.
value	total_committed_matching_gifts.value	double	O valor monetário.
value	total_received_matching_gifts.value	double	O valor monetário.
value	total_soft_credits.value	double	O valor monetário.

ConstituentApi.NoteRead

Observação

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema da anotação.
ID do Constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado à anotação.
Tipo	type	string	O tipo de anotação.
dia	date.d	integer	O dia na data difusa.
month	date.m	integer	O mês na data difusa.
ano	date.y	integer	O ano na data difusa.
Resumo	summary	string	O resumo da anotação.
Observação	text	string	O texto da anotação.
Data de inclusão	date_added	date-time	A data em que a anotação foi criada.
Data modificada	date_modified	date-time	A data em que a anotação foi modificada pela última vez.

ConstituentApi.OnlinePresenceRead

Presença online

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema da presença online.
ID do Constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado à presença online.
Tipo	type	string	O tipo de presença online.
Link	address	string	O endereço da Web para a presença online.
Primário?	primary	boolean	Esta é a principal presença online do constituinte?
Inativo?	inactive	boolean	Essa presença online está inativa?
Data de inclusão	date_added	date-time	A data em que a presença online foi criada.
Data modificada	date_modified	date-time	A data em que a presença online foi modificada pela última vez.

ConstituentApi.PhoneRead

Telefone

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do telefone.
ID do Constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado ao telefone.
Tipo	type	string	O tipo de telefone.
Número	number	string	O número de telefone.
Primário?	primary	boolean	Este é o telefone primário do constituinte?
Não ligar?	do_not_call	boolean	O constituinte pode ser contatado neste número?
Inativo?	inactive	boolean	Esse número de telefone está inativo?
Data de inclusão	date_added	date-time	A data em que o telefone foi criado.
Data modificada	date_modified	date-time	A data em que o telefone foi modificado pela última vez.

ConstituentApi.ProfilePictureRead

Imagem do perfil

Nome	Caminho	Tipo	Description
ID do Constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado à imagem de perfil.
URL	url	string	A URL da imagem de perfil. A URL contém uma assinatura associada ao tempo que limita o acesso a 60 minutos.
URL de miniatura	thumbnail_url	string	A URL de uma miniatura da imagem de perfil. Contém uma assinatura associada ao tempo que limita o acesso a 60 minutos.

ConstituentApi.ProspectStatusRead

Status de perspectiva

Nome	Caminho	Tipo	Description
Situação	status	string	O status de perspectiva atual do constituinte.
Dias decorridos	days_elapsed	integer	Número total de dias no status de perspectiva atual com base na data de início.
Data de início	start	date-time	A data de início do status de perspectiva.
Comments	comments	string	Os comentários sobre o status da perspectiva.

ConstituentApi.RatingRead

Rating

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema da classificação.
ID do Constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado à classificação.
Source	source	string	A origem da nova classificação.
Categoria	category	string	A categoria da classificação.
Date	date	date-time	A data da classificação.
Description	value		O valor da classificação.
Comments	comment	string	Um comentário sobre a classificação.
Inativo?	inactive	boolean	A classificação está inativa?
Tipo	type	string	Esse campo computado indica o tipo de dados que a classificação representa com base na propriedade de categoria.

ConstituentApi.RelationshipRead

Relationship

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema da relação.
ID do Constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado à relação.
ID da relação	relation_id	string	A ID de registro do sistema do indivíduo ou organização relacionado.
ID de relação recíproca	reciprocal_relationship_id	string	O identificador do registro de relação recíproca. Esse valor é somente leitura e é gerado automaticamente quando a relação é criada. As alterações feitas nesse registro também serão refletidas na recíproca, com exceção da propriedade comments.
Nome	name	string	O nome do constituinte relacionado. Se o constituinte relacionado for um indivíduo, esse será o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino.
Tipo	type	string	O tipo de relação que a relação representa.
Tipo recíproco	reciprocal_type	string	Descreve a relação do constituinte com o constituinte relacionado. Por exemplo, em uma relação entre um constituinte masculino e um irmão feminino, o tipo de relação recíproca seria irmão.
dia	start.d	integer	O dia na data difusa.
month	start.m	integer	O mês na data difusa.
ano	start.y	integer	O ano na data difusa.
dia	end.d	integer	O dia na data difusa.
month	end.m	integer	O mês na data difusa.
ano	end.y	integer	O ano na data difusa.
O cônjuge é?	is_spouse	boolean	O indivíduo relacionado é o cônjuge do constituinte (aplica-se apenas às relações entre indivíduos)?
É o chefe de família constituinte?	is_constituent_head_of_household	boolean	O constituinte é o chefe da casa?
O cônjuge é o chefe da casa?	is_spouse_head_of_household	boolean	O cônjuge é o chefe da casa?
Anotações	comment	string	O comentário sobre a relação.
O contato é?	is_organization_contact	boolean	O constituinte representa essa organização como um contato (aplica-se apenas a relações entre organizações e indivíduos)?
Os negócios primários são os principais?	is_primary_business	boolean	Esse é o principal negócio do constituinte (aplica-se apenas às relações entre organizações e indivíduos)?
Tipo de contato	organization_contact_type	string	Fornece contexto para interações com o indivíduo relacionado que representa a organização como um contato. Aplica-se apenas a relações entre organizações e indivíduos.
Cargo	position	string	A posição do indivíduo na organização. Aplica-se apenas a relações entre organizações e indivíduos.
Data de inclusão	date_added	date-time	A data em que a relação foi criada.
Data modificada	date_modified	date-time	A data em que a relação foi modificada pela última vez.

ConstituentApi.SearchResultRead

Resultado da pesquisa

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do constituinte.
Nome	name	string	O nome do constituinte. Para indivíduos, esse campo computado indica o nome completo do constituinte com base nas configurações de nome de exibição da organização de destino.
Endereço	address	string	O endereço preferencial do constituinte.
Falecido?	deceased	boolean	O constituinte está morto?
Email	email	string	O endereço de email do constituinte.
Status da arrecadação de fundos	fundraiser_status	string	O status de arrecadação de fundos do constituinte. Para indivíduos, esse campo computado indica se o constituinte é Ativo, Inativo ou Nenhum. Para as organizações, esse valor sempre será Nenhum.
Inativo?	inactive	boolean	O constituinte está inativo?
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o constituinte.

EventApi.AdministrativeArea

Define o modelo de dados usado para a área administrativa de um endereço (por exemplo: estado nos EUA).

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro da área administrativa.
nome	name	string	O nome da área administrativa.
descrição curta	short_description	string	A breve descrição da área administrativa.

EventApi.ApiCollectionOfEventFee

Taxas

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 EventApi.EventFee	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

EventApi.ApiCollectionOfEventListEntry

Eventos

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 EventApi.EventListEntry	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

EventApi.ApiCollectionOfEventParticipantOption

Opções do participante do evento

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 EventApi.EventParticipantOption	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

EventApi.ApiCollectionOfParticipantDonation

Doaçõ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 EventApi.ParticipantDonation	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

EventApi.ApiCollectionOfParticipantFee

Taxas

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 EventApi.ParticipantFee	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

EventApi.ApiCollectionOfParticipantFeePayment

Pagamentos de taxas

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 EventApi.ParticipantFeePayment	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

EventApi.ApiCollectionOfParticipantListEntry

Participantes

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 EventApi.ParticipantListEntry	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

EventApi.ApiCollectionOfParticipantOption

Opções de participante

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 EventApi.ParticipantOption	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

EventApi.Country

Define o modelo de dados usado para um país de endereço.

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do país.
nome de exibição	display_name	string	O nome de exibição do país.
Código ISO	iso_alpha2_code	string	O código iso 3166-1 alfa-2 para o país.

EventApi.CreatedEvent

Evento criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do evento recém-criado.

EventApi.CreatedEventFee

Taxa de evento criada

Nome	Caminho	Tipo	Description
ID	id	string	A ID da taxa de evento recém-criada.

EventApi.CreatedEventParticipantOption

Opção de participante de evento criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID da opção de participante do evento recém-criada.

EventApi.CreatedParticipant

Participante criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do participante recém-criado.

EventApi.CreatedParticipantDonation

Doação de participante criada

Nome	Caminho	Tipo	Description
ID	id	string	A ID da doação de participante recém-criada.

EventApi.CreatedParticipantFee

Taxa de participante criada

Nome	Caminho	Tipo	Description
ID	id	string	A ID da taxa de participante recém-criada.

EventApi.CreatedParticipantFeePayment

Pagamento de taxa de participante criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do pagamento de taxa do participante recém-criado.

EventApi.CreatedParticipantOption

Opção de participante criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID da opção de participante recém-criada.

EventApi.Event

Event

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do evento. Isso não é o mesmo que o identificador de evento definível pelo usuário, que é armazenado no lookup_id.
Nome	name	string	O nome do evento.
Description	description	string	A descrição do evento.
Data de início	start_date	date	A data de início do evento.
Hora de início	start_time	string	A hora de início do evento.
Data de término	end_date	date	A data de término do evento.
Hora de término	end_time	string	A hora de término do evento.
Categoria	category	EventApi.EventCategory	A categoria de evento é a categorização personalizada para o evento.
ID de pesquisa	lookup_id	string	A ID de pesquisa do evento.
Localização	location	EventApi.Location	Define o modelo de dados usado para um local.
Capacity	capacity	integer	O número de pessoas que podem participar do evento.
Goal	goal	double	A meta monetária do evento.
ID da Campanha	campaign_id	string	A ID de registro do sistema da campanha associada ao evento.
ID do fundo	fund_id	string	A ID do registro do sistema do fundo associado ao evento.
Inativo?	inactive	boolean	O evento está inativo?
Data de inclusão	date_added	date-time	A data em que o evento foi criado.
Data modificada	date_modified	date-time	A data em que o evento foi modificado pela última vez.

EventApi.EventCategory

A categoria de evento é a categorização personalizada para o evento.

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema da categoria de evento.
nome	name	string	O nome da categoria do evento.
inativo?	inactive	boolean	Essa categoria está inativa?

EventApi.EventFee

As taxas de evento são o quanto uma organização cobra para que pessoas ou organizações participem ou participem do evento.

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema da taxa de evento.
nome	name	string	O nome da taxa de evento.
quantidade	cost	double	O custo da taxa.
valor da contribuição	contribution_amount	double	O valor dedutível de impostos para essa taxa.
número vendido	number_sold	integer	O número de taxas vendidas.

EventApi.EventListEntry

Event

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do evento.
Nome	name	string	O nome do evento.
Data de início	start_date	date	A data de início do evento.
Hora de início	start_time	string	A hora de início do evento.
Data de término	end_date	date	A data de término do evento.
Hora de término	end_time	string	A hora de término do evento.
Categoria	category	EventApi.EventCategory	A categoria de evento é a categorização personalizada para o evento.
ID de pesquisa	lookup_id	string	A ID de pesquisa do evento.
Capacity	capacity	integer	O número de pessoas que podem participar do evento.
Atender	attending_count	integer	O número de participantes do evento que planejam participar.
Assistido	attended_count	integer	O número de participantes do evento.
Convidado	invited_count	integer	O número de convites de evento.
Receita	revenue	double	A receita obtida do evento.
Goal	goal	double	A meta monetária do evento.
Porcentagem da meta	percent_of_goal	integer	A receita realizada como um percentual da receita da meta.
Inativo?	inactive	boolean	O evento está inativo?
Data de inclusão	date_added	date-time	A data em que o evento foi criado.
Data modificada	date_modified	date-time	A data em que o evento foi modificado pela última vez.

EventApi.EventParticipantOption

As opções dos participantes do evento são campos que coletam detalhes sobre os participantes, como tamanhos de camiseta, preferências de refeição ou solicitações de assentos. Defina opções e seus valores para um evento e adicione respostas para cada participante.

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema da opção de participante do evento.
nome	name	string	O nome da opção de participante do evento.
tipo de entrada	input_type	string	O tipo da opção de participante do evento.
permitir seleção múltipla?	multi_select	boolean	Permitir mais de um valor para listas?
list_options	list_options	array of EventApi.EventParticipantOptionListOption	As opções de lista disponíveis.
adicionado pelo usuário	added_by_user	string	A ID do usuário que adicionou a opção.
modificado pelo usuário	updated_by_user	string	A ID do usuário que modificou a opção.
adicionado pelo serviço	added_by_service	string	O nome do serviço que adicionou essa opção.
modificado por serviço	updated_by_service	string	O nome do serviço que modificou essa opção.
data adicionada	date_added	date-time	A data em que a opção foi criada.
data modificada	date_updated	date-time	A data em que a opção foi modificada pela última vez.
versão	version	integer	O número de versão da opção.

EventApi.EventParticipantOptionListOption

Uma opção de lista de opções do participante do evento

Nome	Caminho	Tipo	Description
ID	id	string	A ID da opção de lista
nome	name	string	O nome da opção de lista
sequência	sequence	integer	A sequência usada para ordenar as opções de lista

EventApi.Locality

Define o modelo de dados usado para a localidade de um endereço.

Nome	Caminho	Tipo	Description
ID	id	string	A ID de registro do registro de localidade.
nome	name	string	O nome da localidade.

EventApi.Location

Define o modelo de dados usado para um local.

Nome	Caminho	Tipo	Description
nome	name	string	O nome do local.
linhas de endereço	address_lines	string	As linhas de endereço do local.
código postal	postal_code	string	O código postal do local.
localidade	locality	EventApi.Locality	Define o modelo de dados usado para a localidade de um endereço.
área administrativa	administrative_area	EventApi.AdministrativeArea	Define o modelo de dados usado para a área administrativa de um endereço (por exemplo: estado nos EUA).
área sub-administrativa	sub_administrative_area	EventApi.SubAdministrativeArea	Define o modelo de dados usado para a área sub-administrativa de um endereço (por exemplo: cidade nos EUA).
country	country	EventApi.Country	Define o modelo de dados usado para um país de endereço.
endereço formatado	formatted_address	string	O endereço formatado do local

EventApi.Membership

Informações de associação para o participante.

Nome	Caminho	Tipo	Description
Categoria de associação	category	EventApi.MembershipCategory	A categoria de associação do indivíduo.

EventApi.MembershipCategory

A categoria de associação do indivíduo.

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema da categoria de associação.
nome	name	string	O nome da categoria de associação.

EventApi.Participant

Participante

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do participante.
ID do Constituinte	constituent_id	string	A ID constituinte do participante.
ID do evento	event_id	string	A ID de registro do sistema do evento que está sendo assistido.
Host ID	host_id	string	A ID do registro de participante do host.
Status do RSVP	rsvp_status	string	O status do envolvimento do participante com o evento.
Participou?	attended	boolean	O participante participou do evento?
Status do convite	invitation_status	string	O status do convite para o participante.
dia	rsvp_date.d	integer	O dia na data difusa.
month	rsvp_date.m	integer	O mês na data difusa.
ano	rsvp_date.y	integer	O ano na data difusa.
dia	invitation_date.d	integer	O dia na data difusa.
month	invitation_date.m	integer	O mês na data difusa.
ano	invitation_date.y	integer	O ano na data difusa.
Nível de participação	participation_level	EventApi.ParticipationLevel	Os níveis de participação são o nível de envolvimento que os participantes têm em um evento.
Data de inclusão	date_added	date-time	A data em que o participante foi criado.
Data modificada	date_modified	date-time	A data em que o participante foi modificado pela última vez.

EventApi.ParticipantDonation

Define um modelo de dados para uma doação de participante

Nome	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema da doação do participante.
ID do presente	gift_id	string	A ID do registro do sistema do presente ao qual a doação do participante está vinculada.

EventApi.ParticipantFee

Define um modelo de dados para uma taxa de participante

Nome	Caminho	Tipo	Description
ID	id	string	A ID do valor do participante.
ID do participante	participant_id	string	A ID do registro ao qual a taxa do participante está vinculada.
quantidade	quantity	integer	A quantidade comprada.
valor da taxa	fee_amount	double	O valor da taxa do participante.
valor da contribuição	tax_receiptable_amount	double	O valor dedutível de impostos para essa taxa.
dia	date.d	integer	O dia na data difusa.
month	date.m	integer	O mês na data difusa.
ano	date.y	integer	O ano na data difusa.
Taxa de evento	event_fee	EventApi.EventFee	As taxas de evento são o quanto uma organização cobra para que pessoas ou organizações participem ou participem do evento.

EventApi.ParticipantFeePayment

Define um modelo de dados para um pagamento de taxa de participante

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do pagamento da taxa do participante.
ID do participante	participant_id	string	A ID de registro do sistema do participante ao qual o pagamento da taxa de participante está vinculado.
ID do presente	gift_id	string	A ID do registro do sistema do presente ao qual o pagamento da taxa de participante está vinculado.
valor aplicado	applied_amount	double	O valor aplicado do pagamento da taxa do participante.

EventApi.ParticipantListEntry

Participante

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do participante.
ID de contato	contact_id	string	A ID do contato que participa do evento.
Status do RSVP	rsvp_status	string	O status do envolvimento do participante com o evento.
Participou?	attended	boolean	O participante participou do evento?
Status do convite	invitation_status	string	O status do convite para o participante.
dia	rsvp_date.d	integer	O dia na data difusa.
month	rsvp_date.m	integer	O mês na data difusa.
ano	rsvp_date.y	integer	O ano na data difusa.
Nível de participação	participation_level	EventApi.ParticipationLevel	Os níveis de participação são o nível de envolvimento que os participantes têm em um evento.
Title	title	string	O título do participante.
Nome	first_name	string	O nome do participante.
Sobrenome	last_name	string	O sobrenome do participante.
Nome	name	string	O nome completo do participante.
Nome preferencial	preferred_name	string	O nome preferencial do participante.
Sufixo	suffix	string	O sufixo do participante.
ID de pesquisa	lookup_id	string	A LookupId do participante.
Email	email	string	O endereço de email do participante.
Não enviar email?	do_not_email	boolean	O participante pode ser contatado neste endereço de email?
Telefone	phone	string	O número de telefone do participante.
Não ligar?	do_not_call	boolean	O participante pode ser contatado com esse número?
Nome do meio	middle_name	string	O nome do meio do participante.
Nome antigo	former_name	string	O nome antigo do participante.
É um constituinte?	is_constituent	boolean	O participante é um constituinte?
Classe de	class_of	string	A turma de graduação do participante.
Taxas totais de registro	total_registration_fees	double	A soma dos valores de taxa do participante.
Total pago	total_paid	double	A soma dos presentes pagos do participante com um tipo de Taxas de Registro.
Assento	seat	string	A atribuição de assento para o participante.
Marca de nome	name_tag	string	A marca de nome do participante
Data de inclusão	date_added	date-time	A data em que o participante foi criado.
Data modificada	date_modified	date-time	A data em que o participante foi modificado pela última vez.
ID de contato	host.contact_id	string	A ID do contato que participa do evento.
ID do participante	host.participant_id	string	A ID do participante.
nome	host.name	string	O nome completo do participante.
Os hóspedes	guests	array of EventApi.ParticipantListParticipantSummary	Os convidados do participante.
Associações	memberships	array of EventApi.Membership	As informações de associação do participante.

EventApi.ParticipantListParticipantSummary

As informações de resumo básicas do participante.

Nome	Caminho	Tipo	Description
ID de contato	contact_id	string	A ID do contato que participa do evento.
ID do participante	participant_id	string	A ID do participante.
nome	name	string	O nome completo do participante.

EventApi.ParticipantOption

A opção de participante associada a um determinado participante

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema da opção de participante.
ID do participante	participant_id	string	A ID do registro do sistema do participante.
ID do evento	event_id	string	A ID do registro do sistema do evento.
ID da opção do participante do evento	event_participant_option_id	string	A ID do registro do sistema da opção de participante do evento.
value	option_value	string	A resposta do participante à opção.
adicionado pelo usuário	added_by_user	string	A ID do usuário que adicionou a opção de participante.
modificado pelo usuário	updated_by_user	string	A ID do usuário que modificou a opção de participante.
adicionado pelo serviço	added_by_service	string	O nome do serviço que adicionou essa opção de participante.
modificado por serviço	updated_by_service	string	O nome do serviço que modificou essa opção de participante.
data adicionada	date_added	date-time	A data em que a opção participante foi criada.
data modificada	date_updated	date-time	A data em que a opção participante foi modificada pela última vez.

EventApi.ParticipationLevel

Os níveis de participação são o nível de envolvimento que os participantes têm em um evento.

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do nível de participação.
nome	name	string	O nome do nível de participação.
inativo?	is_inactive	boolean	O nível de participação está inativo?

EventApi.SubAdministrativeArea

Define o modelo de dados usado para a área sub-administrativa de um endereço (por exemplo: cidade nos EUA).

Nome	Caminho	Tipo	Description
ID	id	string	A ID da área sub-administrativa.
nome	name	string	O nome da área sub-administrativa.

FundraisingApi.ApiCollectionOfAppealAttachmentRead

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 FundraisingApi.AppealAttachmentRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

FundraisingApi.ApiCollectionOfAppealCustomFieldRead

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 FundraisingApi.AppealCustomFieldRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

FundraisingApi.ApiCollectionOfAppealRead

Contestaçõ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 FundraisingApi.AppealRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

FundraisingApi.ApiCollectionOfCampaignAttachmentRead

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 FundraisingApi.CampaignAttachmentRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

FundraisingApi.ApiCollectionOfCampaignCustomFieldRead

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 FundraisingApi.CampaignCustomFieldRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

FundraisingApi.ApiCollectionOfCampaignRead

Campaigns

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 FundraisingApi.CampaignRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

FundraisingApi.ApiCollectionOfFundAttachmentRead

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 FundraisingApi.FundAttachmentRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

FundraisingApi.ApiCollectionOfFundCustomFieldRead

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 FundraisingApi.FundCustomFieldRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

FundraisingApi.ApiCollectionOfFundRead

Fundos

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 FundraisingApi.FundRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

FundraisingApi.ApiCollectionOfFundraiserAssignmentRead

Assignments

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 FundraisingApi.FundraiserAssignmentRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

FundraisingApi.ApiCollectionOfPackageRead

Packages

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 FundraisingApi.PackageRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

FundraisingApi.AppealAttachmentRead

Anexo

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do anexo.
ID de recurso	parent_id	string	A ID do registro do sistema do recurso associado 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.

FundraisingApi.AppealCustomFieldRead

Campo personalizado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do campo personalizado.
ID de recurso	parent_id	string	A ID do registro do sistema do recurso associado 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.
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.

FundraisingApi.AppealRead

Appeal

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do recurso.
Categoria	category	string	A categoria do recurso.
Data de inclusão	date_added	date-time	A data em que o recurso foi criado.
Data modificada	date_modified	date-time	A data em que o recurso foi modificado pela última vez.
Description	description	string	O nome de exibição do recurso.
Data de término	end_date	date-time	A data de término do recurso.
value	goal.value	double	O valor monetário.
Inativo?	inactive	boolean	O recurso está ativo (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o recurso.
Data de início	start_date	date-time	A data de início do recurso.

FundraisingApi.CampaignAttachmentRead

Anexo

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do anexo.
ID da Campanha	parent_id	string	A ID do registro do sistema da campanha 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.

FundraisingApi.CampaignCustomFieldRead

Campo personalizado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do campo personalizado.
ID da Campanha	parent_id	string	A ID do registro do sistema da campanha 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.
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.

FundraisingApi.CampaignRead

Campanha

Nome	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema da campanha.
Categoria	category	string	A categoria da campanha.
Data de inclusão	date_added	date-time	A data em que a campanha foi criada.
Data modificada	date_modified	date-time	A data em que a campanha foi modificada pela última vez.
Description	description	string	O nome de exibição da campanha.
Data de término	end_date	date-time	A data de término da campanha.
value	goal.value	double	O valor monetário.
Inativo?	inactive	boolean	A campanha está inativa (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para a campanha.
Data de início	start_date	date-time	A data de início da campanha.

FundraisingApi.CreatedAppealAttachment

Anexo de recurso criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do anexo de recurso recém-criado.

FundraisingApi.CreatedAppealCustomField

Campo personalizado de recurso criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do campo personalizado de apelo recém-criado.

FundraisingApi.CreatedCampaignAttachment

Anexo de campanha criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do anexo de campanha recém-criado.

FundraisingApi.CreatedCampaignCustomField

Campo personalizado de campanha criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do campo personalizado da campanha recém-criado.

FundraisingApi.CreatedFundraiserAssignment

Criação de atribuição de arrecadação de fundos

Nome	Caminho	Tipo	Description
ID	id	string	A ID da recém-criada tarefa de arrecadação de fundos.

FundraisingApi.CreatedFundAttachment

Anexo de fundo criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do anexo do fundo recém-criado.

FundraisingApi.CreatedFundCustomField

Campo personalizado do fundo criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do campo personalizado do fundo recém-criado.

FundraisingApi.FundraiserAssignmentRead

Assignment

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema da tarefa de arrecadação de fundos.
ID do Constituinte	constituent_id	string	A ID do registro do sistema do constituinte atribuído.
Tipo	type	string	O tipo de arrecadação de fundos.
Início da atribuição	start	date-time	A data de início da atribuição.
Termina a atribuição	end	date-time	A data de término da atribuição.
value	amount.value	double	O valor monetário.
ID da Campanha	campaign_id	string	A ID de registro do sistema da campanha à qual os presentes resultantes serão aplicados.
ID do fundo	fund_id	string	A ID de registro do sistema do fundo ao qual os presentes resultantes serão aplicados.
ID de recurso	appeal_id	string	A ID do registro do sistema do recurso ao qual os presentes resultantes serão aplicados.

FundraisingApi.FundAttachmentRead

Anexo

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do anexo.
ID do fundo	parent_id	string	A ID do registro do sistema do fundo associado 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.

FundraisingApi.FundCustomFieldRead

Campo personalizado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do campo personalizado.
ID do fundo	parent_id	string	A ID do registro do sistema do fundo associado 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.
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.

FundraisingApi.FundRead

Fundo

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do fundo.
Categoria	category	string	A categoria do fundo.
Data de inclusão	date_added	date-time	A data em que o fundo foi criado.
Data modificada	date_modified	date-time	A data em que o fundo foi modificado pela última vez.
Description	description	string	O nome de exibição do fundo.
Data de término	end_date	date-time	A data de término do fundo.
value	goal.value	double	O valor monetário.
Inativo?	inactive	boolean	O fundo está inativo (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o fundo.
Data de início	start_date	date-time	A data de início do fundo.
Tipo	type	string	O tipo do fundo.

FundraisingApi.PackageRead

Package

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do pacote.
ID de recurso	appeal_id	string	A ID do registro do sistema do recurso associado a este pacote.
Categoria	category	string	A categoria do pacote.
Data de inclusão	date_added	date-time	A data em que o pacote foi criado.
Data modificada	date_modified	date-time	A data em que o pacote foi modificado pela última vez.
value	default_gift_amount.value	double	O valor monetário.
Description	description	string	O nome de exibição do pacote.
Data de término	end	date-time	A data de término do pacote.
value	goal.value	double	O valor monetário.
Inativo?	inactive	boolean	O pacote está inativo (ou seja, a data atual é após qualquer data de início e antes de qualquer data de término)?
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o pacote.
Anotações	notes	string	As anotações no pacote.
Contagem de destinatários	recipient_count	integer	O número de destinatários do pacote.
Data de início	start	date-time	A data de início do pacote.

GiftApi.AcknowledgementRead

Reconhecimento

Nome	Caminho	Tipo	Description
date	date	date-time	A data associada à confirmação.
letra	letter	string	A carta associada à confirmação.
status	status	string	O status da confirmação. Os valores disponíveis são: ACKNOWLEDGED, NEEDSACKNOWLEDGEMENT e DONOTACKNOWLEDGE.

GiftApi.ApiCollectionOfGiftAttachmentRead

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 GiftApi.GiftAttachmentRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

GiftApi.ApiCollectionOfGiftCustomFieldRead

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 GiftApi.GiftCustomFieldRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

GiftApi.ApiCollectionOfGiftRead

Presentes

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 GiftApi.GiftRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

GiftApi.BatchGiftAddResults

Contém uma coleção de registros de erro de presente em lotes e os presentes em lote que a operação adicionou

Nome	Caminho	Tipo	Description
Erros	errors	array of GiftApi.GiftBatchGiftError	Os erros de presente do lote associados à operação de adição de presentes em lote
Presentes	gifts	array of GiftApi.BatchGiftRead	A coleção de presentes em lote que foram adicionados pela operação de adição de presentes em lote

GiftApi.GiftBatchGiftError

Representa exceções que impedem que itens sejam adicionados ao lote.

Nome	Caminho	Tipo	Description
campo afetado	affected_field	string	O campo afetado pelo erro
ID do lote	batch_id	string	A ID do registro do sistema do lote
código de erro de exceção	exception_error_code	integer	O código de erro de exceção
mensagem de erro de exceção	exception_error_message	string	A mensagem de erro de exceção
nome do erro de exceção	exception_error_name	string	O nome do erro de exceção
ID do presente	gift_id	string	A ID do registro do sistema do presente
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o presente.

GiftApi.BatchGiftRead

Presente em lote

Nome	Caminho	Tipo	Description
ID do lote	batch_id	string	A ID do lote ao qual o presente foi adicionado.
Erros	errors	array of GiftApi.GiftBatchGiftError	Os erros associados ao presente em lote.
ID	id	string	A ID do registro do sistema do presente do lote.
ID do constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado ao presente.
tipo	type	string	O tipo de presente.
Subtipo	subtype	string	O subtipo do presente.
date	date	date-time	A data do presente.
value	amount.value	double	O valor monetário.
value	balance.value	double	O valor monetário.
número do lote	batch_number	string	O número do lote associado a este presente.
status	gift_status	string	O status do presente.
anônimo?	is_anonymous	boolean	O presente é anônimo?
clientes	constituency	string	O eleitorado do presente.
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o presente.
origem	origin	string	A origem do presente.
pós-status	post_status	string	O status de postagem geral do razão do presente. Os valores disponíveis são Posted, NotPosted e DoNotPost. Quando post_status é definido como DoNotPost>, post_date deve ser nulo. Quando ele é definido como NotPosted, post_date é necessário, mas permanece editável. Quando ele é definido como Postado, post_date é necessário e não é mais editável.
data da postagem	post_date	date-time	A data em que o presente foi postado no razão geral.
referência	reference	string	Notas para acompanhar detalhes especiais sobre um presente, como a motivação por trás dele ou uma descrição detalhada de um presente em espécie.
dia	recurring_gift_status_date.d	integer	O dia na data difusa.
month	recurring_gift_status_date.m	integer	O mês na data difusa.
ano	recurring_gift_status_date.y	integer	O ano na data difusa.
frequência	recurring_gift_schedule.frequency	string	Frequência de parcelamento do presente recorrente a ser exibido. Os valores disponíveis são WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, ANNUALLY.
start	recurring_gift_schedule.start_date	date-time	Data em que o presente recorrente deve começar.
término	recurring_gift_schedule.end_date	date-time	Data em que o presente recorrente deve terminar.
value	gift_aid_amount.value	double	O valor monetário.
status de qualificação de auxílio-presente	gift_aid_qualification_status	string	Esse campo computado determina o status de qualificação do Gift Aid com base nas informações da declaração de imposto e no formato de banco de dados. Os valores disponíveis são: Qualificado, NotQualificado e Parcialmente Qualificado. Apenas para o Reino Unido.
código de presente	gift_code	string	O valor do código presente associado ao presente.
divisões de presentes	gift_splits	array of GiftApi.GiftSplitRead	O conjunto de divisões de presentes associadas ao presente.
arrecadação de fundos	fundraisers	array of GiftApi.GiftFundraiserRead	O conjunto de arrecadações de fundos que recebem crédito pelo presente.
Créditos suaves	soft_credits	array of GiftApi.SoftCreditRead	O conjunto de créditos suaves associados ao presente.
Recibos	receipts	array of GiftApi.ReceiptRead	O conjunto de recibos associados ao presente.
Reconhecimento	acknowledgements	array of GiftApi.AcknowledgementRead	O conjunto de confirmações associadas ao presente.
Payments	payments	array of GiftApi.PaymentRead	Os pagamentos do presente.
Presentes vinculados	linked_gifts	array of string	Os identificadores de outros presentes que estão vinculados a este presente.
Data de inclusão	date_added	date-time	A data em que o presente foi criado.
Data modificada	date_modified	date-time	A data em que o presente foi modificado pela última vez.

GiftApi.CreatedGift

Presente criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do presente recém-criado.

GiftApi.CreatedGiftAttachment

Anexo de presente criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do anexo de presente recém-criado.

GiftApi.CreatedGiftCustomField

Campo personalizado de presente criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do campo personalizado do presente recém-criado.

GiftApi.GiftAttachmentRead

Anexo

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do anexo.
ID do presente	parent_id	string	A ID do registro do sistema do presente associado 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.

GiftApi.GiftCustomFieldRead

Campo personalizado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do campo personalizado.
ID do presente	parent_id	string	A ID do registro do sistema do presente associado 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.
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.

GiftApi.GiftFundraiserRead

Arrecadação de presentes

Nome	Caminho	Tipo	Description
value	amount.value	double	O valor monetário.
ID de arrecadação de fundos	constituent_id	string	A ID do registro do sistema constituinte para a arrecadação de fundos associada ao presente.

GiftApi.GiftRead

Presente

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do presente.
ID do Constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado ao presente.
Tipo	type	string	O tipo de presente.
Subtipo	subtype	string	O subtipo do presente.
Date	date	date-time	A data do presente.
value	amount.value	double	O valor monetário.
value	balance.value	double	O valor monetário.
Número do lote	batch_number	string	O número do lote associado a este presente.
Situação	gift_status	string	O status do presente.
Anônimo?	is_anonymous	boolean	O presente é anônimo?
Círculo eleitoral	constituency	string	O eleitorado do presente.
ID de pesquisa	lookup_id	string	O identificador definido pelo usuário para o presente.
Origin	origin	string	A origem do presente.
Status da postagem	post_status	string	O status de postagem geral do razão do presente. Os valores disponíveis são Posted, NotPosted e DoNotPost. Quando post_status é definido como DoNotPost>, post_date deve ser nulo. Quando ele é definido como NotPosted, post_date é necessário, mas permanece editável. Quando ele é definido como Postado, post_date é necessário e não é mais editável.
Data da postagem	post_date	date-time	A data em que o presente foi postado no razão geral.
Referência	reference	string	Notas para acompanhar detalhes especiais sobre um presente, como a motivação por trás dele ou uma descrição detalhada de um presente em espécie.
dia	recurring_gift_status_date.d	integer	O dia na data difusa.
month	recurring_gift_status_date.m	integer	O mês na data difusa.
ano	recurring_gift_status_date.y	integer	O ano na data difusa.
frequência	recurring_gift_schedule.frequency	string	Frequência de parcelamento do presente recorrente a ser exibido. Os valores disponíveis são WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, ANNUALLY.
start	recurring_gift_schedule.start_date	date-time	Data em que o presente recorrente deve começar.
término	recurring_gift_schedule.end_date	date-time	Data em que o presente recorrente deve terminar.
value	gift_aid_amount.value	double	O valor monetário.
Status de qualificação do auxílio-presente	gift_aid_qualification_status	string	Esse campo computado determina o status de qualificação do Gift Aid com base nas informações da declaração de imposto e no formato de banco de dados. Os valores disponíveis são: Qualificado, NotQualificado e Parcialmente Qualificado. Apenas para o Reino Unido.
Código do presente	gift_code	string	O valor do código presente associado ao presente.
Divisões de presentes	gift_splits	array of GiftApi.GiftSplitRead	O conjunto de divisões de presentes associadas ao presente.
Arrecadação de fundos	fundraisers	array of GiftApi.GiftFundraiserRead	O conjunto de arrecadações de fundos que recebem crédito pelo presente.
Créditos suaves	soft_credits	array of GiftApi.SoftCreditRead	O conjunto de créditos suaves associados ao presente.
Recibos	receipts	array of GiftApi.ReceiptRead	O conjunto de recibos associados ao presente.
Reconhecimento	acknowledgements	array of GiftApi.AcknowledgementRead	O conjunto de confirmações associadas ao presente.
Payments	payments	array of GiftApi.PaymentRead	Os pagamentos do presente.
Presentes vinculados	linked_gifts	array of string	Os identificadores de outros presentes que estão vinculados a este presente.
Data de inclusão	date_added	date-time	A data em que o presente foi criado.
Data modificada	date_modified	date-time	A data em que o presente foi modificado pela última vez.

GiftApi.GiftSplitRead

Divisão de presentes

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema da divisão de presentes.
value	amount.value	double	O valor monetário.
ID de recurso	appeal_id	string	A ID do registro do sistema do recurso associado à divisão do presente.
ID da campanha	campaign_id	string	A ID do registro do sistema da campanha associada à divisão de presentes.
ID do fundo	fund_id	string	A ID do registro do sistema do fundo associado à divisão de presentes.
value	gift_aid_amount.value	double	O valor monetário.
status de qualificação de auxílio-presente	gift_aid_qualification_status	string	O status de qualificação do auxílio-presente da divisão de presentes. Os valores disponíveis são: Qualificado e NotQualificado. Apenas para o Reino Unido.
ID do pacote	package_id	string	A ID do registro do sistema do pacote associado à divisão de presentes.

GiftApi.ReceiptRead

Recebimento

Nome	Caminho	Tipo	Description
value	amount.value	double	O valor monetário.
date	date	date-time	A data do recibo.
número	number	integer	O número do recibo.
status	status	string	O status do recibo. Os valores disponíveis são: RECEIPTED, NEEDSRECEIPT e DONOTRECEIPT.

GiftApi.PaymentRead

Pagamento

Nome	Caminho	Tipo	Description
token de conta	account_token	string	As informações da conta tokenizada (por exemplo: cartão de crédito) do provedor de pagamento externo. Aplica-se apenas às formas de pagamento de "CreditCard" e "DirectDebit".
ID de configuração do BBPS	bbps_configuration_id	string	A ID de configuração do BBPS. Aplica-se apenas às formas de pagamento de "CreditCard" e "DirectDebit".
ID da transação do BBPS	bbps_transaction_id	string	A ID da transação BBPS. Aplica-se apenas às formas de pagamento de "CreditCard" e "DirectDebit".
dia	check_date.d	integer	O dia na data difusa.
month	check_date.m	integer	O mês na data difusa.
ano	check_date.y	integer	O ano na data difusa.
número de verificação	check_number	string	O número de verificação. Aplica-se apenas à forma de pagamento de "PersonalCheck".
ID da transação de check-out	checkout_transaction_id	string	A ID da transação de check-out. Aplica-se apenas às formas de pagamento de "CreditCard" e "DirectDebit".
forma de pagamento	payment_method	string	A forma de pagamento. Os valores disponíveis estão listados abaixo.
referência	reference	string	A referência. Aplica-se apenas à forma de pagamento de "Outros".
dia	reference_date.d	integer	O dia na data difusa.
month	reference_date.m	integer	O mês na data difusa.
ano	reference_date.y	integer	O ano na data difusa.

GiftApi.SoftCreditRead

Crédito suave

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do crédito reversível.
value	amount.value	double	O valor monetário.
ID do constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado ao crédito reversível.
ID do presente	gift_id	string	A ID do registro do sistema do presente associado ao crédito reversível.

GiftBatchApi.ApiCollectionOfGiftBatch

Lotes de presentes

Nome	Caminho	Tipo	Description
Contagem	count	integer	O número total de lotes de presentes na resposta.
value	value	array of GiftBatchApi.GiftBatch	O conjunto de itens incluídos na resposta.

GiftBatchApi.CreatedBatch

Lote de presentes criado

Nome	Caminho	Tipo	Description
ID	batch_id	string	A ID do registro do sistema do lote de presentes recém-criado.

GiftBatchApi.GiftBatch

Representa o objeto do lote de presentes

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do lote.
descrição	batch_description	string	A descrição do lote.
número do lote	batch_number	string	O número do lote
número projetado	projected_number_of_gifts	integer	O número projetado de presentes no lote.
número real	number_of_gifts	integer	O número real de presentes no lote.
valor projetado	projected_amount	double	O valor projetado de presentes no lote.
valor real	actual_amount	double	O valor real dos presentes no lote.
tem exceções?	has_exceptions	boolean	O lote tem exceções?
aprovado?	is_approved	boolean	O lote foi aprovado?
Criado por	created_by	string	O nome do usuário que criou o lote.
Criado em	created_on	date-time	A data em que o lote foi criado.

ListApi.CreatedList

Lista criada

Nome	Caminho	Tipo	Description
ID	id	string	A ID da lista recém-criada.

OpportunityApi.ApiCollectionOfOpportunityAttachmentRead

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 OpportunityApi.OpportunityAttachmentRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

OpportunityApi.ApiCollectionOfOpportunityCustomFieldRead

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 OpportunityApi.OpportunityCustomFieldRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

OpportunityApi.ApiCollectionOfOpportunityRead

Oportunidades

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 OpportunityApi.OpportunityRead	O conjunto de itens incluídos na resposta. Pode ser um subconjunto dos itens na coleção.

OpportunityApi.CreatedOpportunity

Oportunidade criada

Nome	Caminho	Tipo	Description
ID	id	string	A ID da oportunidade recém-criada.

OpportunityApi.CreatedOpportunityAttachment

Anexo de oportunidade criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do anexo de oportunidade recém-criado.

OpportunityApi.CreatedOpportunityCustomField

Anexo de oportunidade criado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do anexo de oportunidade recém-criado.

OpportunityApi.Fundraiser

Arrecadação de fundos

Nome	Caminho	Tipo	Description
ID do Constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado à arrecadação de fundos.
value	credit_amount.value	double	O valor monetário.

OpportunityApi.OpportunityAttachmentRead

Anexo

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do anexo.
ID da oportunidade	parent_id	string	A ID do registro do sistema da oportunidade 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.

OpportunityApi.OpportunityCustomFieldRead

Campo personalizado

Nome	Caminho	Tipo	Description
ID	id	string	A ID do registro do sistema do campo personalizado.
ID da oportunidade	parent_id	string	A ID do registro do sistema da oportunidade 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.
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.

OpportunityApi.OpportunityRead

Oportunidade

Nome	Caminho	Tipo	Description
ID	id	string	A ID de registro do sistema da oportunidade.
ID do Constituinte	constituent_id	string	A ID do registro do sistema do constituinte associado à oportunidade.
Propósito	purpose	string	O uso pretendido para qualquer dinheiro arrecadado como resultado da oportunidade.
Nome	name	string	O nome que identifica a oportunidade em todo o programa, como em listas ou em registros constituintes. Limite de caracteres: 255.
Situação	status	string	O status que indica onde a oportunidade está no processo de solicitação.
Data limite	deadline	date-time	A data da meta para a oportunidade de resultar em um presente.
Data da pergunta	ask_date	date-time	A data em que a solicitação foi feita.
value	ask_amount.value	double	O valor monetário.
Data esperada	expected_date	date-time	A data em que se espera que a perspectiva seja fornecida em resposta à oportunidade.
value	expected_amount.value	double	O valor monetário.
Data financiada	funded_date	date-time	A data em que a perspectiva deu em resposta à oportunidade.
value	funded_amount.value	double	O valor monetário.
ID da Campanha	campaign_id	string	A ID de registro do sistema da campanha associada à oportunidade. A campanha define os objetivos gerais para arrecadar dinheiro.
ID do fundo	fund_id	string	A ID de registro do sistema do fundo associado à oportunidade. O fundo designa a finalidade financeira específica de um presente e identifica a conta financeira desse presente.
Arrecadação de fundos	fundraisers	array of OpportunityApi.Fundraiser	O conjunto de IDs de registro do sistema para as arrecadações de fundos atribuídas à oportunidade.
Inativo?	inactive	boolean	A oportunidade está inativa?
linked_gifts	linked_gifts	array of string	As IDs de registro do sistema dos presentes relacionados à oportunidade.
Data de inclusão	date_added	date-time	A data em que a oportunidade foi criada.
Data modificada	date_modified	date-time	A data em que a oportunidade foi modificada pela última vez.

Compartilhar via

Blackbaud Raisers Edge NXT (versão prévia)

Pré-requisitos

Como obter credenciais?

Problemas e limitações conhecidos

Limitações

Ações

Adicionar registros a uma lista

Parâmetros

Adicionar um presente ao lote

Parâmetros

Retornos

Atualizar detalhes de confirmação do presente

Parâmetros

Atualizar detalhes do recibo do presente

Parâmetros

Atualizar um alias constituinte

Parâmetros

Atualizar um anexo constituinte

Parâmetros

Atualizar um anexo de ação

Parâmetros

Atualizar um anexo de campanha

Parâmetros

Atualizar um anexo de fundo

Parâmetros

Atualizar um anexo de oportunidade

Parâmetros

Atualizar um anexo de presente

Parâmetros

Atualizar um anexo de recurso

Parâmetros

Atualizar um campo personalizado constituinte

Parâmetros

Atualizar um campo personalizado de ação

Parâmetros

Atualizar um campo personalizado de campanha

Parâmetros

Atualizar um campo personalizado de oportunidade

Parâmetros

Atualizar um campo personalizado de presente

Parâmetros

Atualizar um campo personalizado de recurso

Parâmetros

Atualizar um campo personalizado do fundo

Parâmetros

Atualizar um constituinte

Parâmetros

Atualizar um código constituinte

Parâmetros

Atualizar um código de solicitação constituinte

Parâmetros

Atualizar um endereço constituinte

Parâmetros

Atualizar um endereço de email constituinte

Parâmetros

Atualizar um evento

Parâmetros

Atualizar um participante

Parâmetros

Atualizar um telefone constituinte

Parâmetros

Atualizar uma ação constituinte

Parâmetros

Atualizar uma educação constituinte

Parâmetros

Atualizar uma imagem de perfil constituinte

Parâmetros

Atualizar uma nota constituinte

Parâmetros

Atualizar uma oportunidade

Parâmetros

Atualizar uma opção de participante

Parâmetros

Atualizar uma presença online constituinte

Parâmetros

Atualizar uma relação constituinte

Parâmetros

Criar um alias constituinte

Parâmetros