Dela via

Blackbaud Raisers Edge NXT Interaktioner

Blackbaud Raiser's Edge NXT är en omfattande molnbaserad programvarulösning för insamling och hantering av givare som skapats specifikt för ideella organisationer och hela det sociala goda samhället. Använd interaktionsanslutningsappen för att hantera konstituerande åtgärder.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster Class Regioner
Copilot Studio Premie Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Logiska appar Norm Alla Logic Apps-regioner utom följande:
     – Azure Government-regioner
     – Regioner i Azure Kina
     - US Department of Defense (DoD)
Power Apps Premie Alla Power Apps-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Power Automate Premie Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Kontakt
Namn Blackbaud Support
URL https://www.blackbaud.com/support
E-postmeddelande skyapi@blackbaud.com
Metadata för anslutningsprogram
Utgivare Blackbaud, Inc.
Webbplats https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt
Sekretesspolicy https://www.blackbaud.com/privacy-shield
Kategorier Försäljning och CRM; Produktivitet

Raiser's Edge NXT är en omfattande molnbaserad programvarulösning för insamling och hantering av givare som skapats specifikt för ideella organisationer och hela samhället.

Den här anslutningsappen bygger på Blackbauds SKY API och tillhandahåller åtgärder för att hantera konstituerande interationer och relaterade entiteter i The Raisers Edge NXT, inklusive:

  • Åtgärder
  • Anpassade åtgärdsfält
  • Åtgärdsbilagor
  • med flera...

Mer information finns i dokumentationen.

Förutsättningar

Om du vill använda den här anslutningsappen måste du ha ett Blackbaud-ID-konto med åtkomst till en eller flera Blackbaud-miljöer.

Dessutom måste organisationens administratör också utföra en åtgärd på administratörsnivå i systemet för att den här anslutningsappen ska få åtkomst till din Blackbaud-miljö. Mer information om dessa förutsättningar finns i den första installationsdokumentationen .

Hur hämtar jag autentiseringsuppgifter?

Organisationens administratör skickar en inbjudan till organisationens Raiser's Edge NXT-miljö och konfigurerar dina användarkontobehörigheter i miljön. Inga ytterligare autentiseringsuppgifter krävs för att använda den här anslutningsappen.

Kända problem och begränsningar

Anslutningsappen fungerar i kontexten för ditt användarkonto och kommer därför att omfattas av dina användarbehörigheter i miljön.

Begränsningsgränser

Name Anrop Förnyelseperiod
API-anrop per anslutning 100 60 sekunder

Åtgärder

Hämta en komponentåtgärd

Returnerar information om en komponentåtgärd.
Lista konstituerande åtgärder

Visar en lista över åtgärder för en komponent.
Lista åtgärder

Returnerar en lista över åtgärder.
Lista åtgärdsbilagor

Visar en lista över bifogade filer för en åtgärd.
Skapa en bifogad åtgärd

Skapar en ny bifogad åtgärd.
Skapa en komponentåtgärd

Skapar en ny komponentåtgärd.
Skapa ett anpassat åtgärdsfält

Skapar ett nytt anpassat åtgärdsfält.
Uppdatera en bifogad åtgärd

Uppdaterar en bifogad åtgärd.
Uppdatera en komponentåtgärd

Uppdaterar en komponentåtgärd.
Uppdatera ett anpassat åtgärdsfält

Uppdaterar ett anpassat åtgärdsfält.
Visa anpassade fält för liståtgärd

Visar en lista över anpassade fält för en åtgärd.

Hämta en komponentåtgärd

Åtgärds-ID:
GetAction

Returnerar information om en komponentåtgärd.

Parametrar

Name Nyckel Obligatorisk Typ Description
Åtgärds-ID
 action_id True string

Systempost-ID för åtgärden som ska hämtas.

Returer

Åtgärd

Body
ConstituentApi.ActionRead

Lista konstituerande åtgärder

Åtgärds-ID:
ListConstituentActions

Visar en lista över åtgärder för en komponent.

Parametrar

Name Nyckel Obligatorisk Typ Description
Komponent-ID
 constituent_id True string

Komponentens systempost-ID.

Returer

Åtgärder

Body
ConstituentApi.ApiCollectionOfActionRead

Lista åtgärder

Åtgärds-ID:
ListActions

Returnerar en lista över åtgärder.

Parametrar

Name Nyckel Obligatorisk Typ Description
List
 list_id string

Definierar en listidentifierare som används för att filtrera uppsättningen med åtgärder till de som ingår i den angivna listan. Om det här värdet anges ignoreras andra angivna filter.
Beräknad status
 computed_status string

Representerar ett filter för resultat baserat på den beräknade åtgärdsstatusen. Tillgängliga värden är Open, Completed eller PastDue.
Läge
 status_code string

Representerar en åtgärdsstatuskod för att filtrera resultatet (gäller endast när systemet är konfigurerat att använda åtgärdsstatuskoder). Till exempel returnerar "Väntande" åtgärder med statusen "Väntar".
Limit
 limit integer

Representerar antalet poster som ska returneras. Standardvärdet är 500. Maxvärdet är 5 000.
Offset
 offset integer

Representerar antalet poster som ska hoppa över. För användning med sidnumrering.
Läggs till på eller efter
 date_added date-time

Filtrera resultatet till åtgärder som skapats på eller efter det angivna datumet (t.ex. "2020-09-18T04:13:56Z").
Ändrad på eller efter
 last_modified date-time

Filtrera resultatet till åtgärder som ändrats på eller efter det angivna datumet (t.ex. "2020-09-18T04:13:56Z").

Returer

Åtgärder

Body
ConstituentApi.ApiCollectionOfActionRead

Lista åtgärdsbilagor

Åtgärds-ID:
ListActionAttachments

Visar en lista över bifogade filer för en åtgärd.

Parametrar

Name Nyckel Obligatorisk Typ Description
Åtgärds-ID
 action_id True string

Åtgärdens systempost-ID.

Returer

Attachments

Body
ConstituentApi.ApiCollectionOfActionAttachmentRead

Skapa en bifogad åtgärd

Åtgärds-ID:
CreateActionAttachment

Skapar en ny bifogad åtgärd.

Parametrar

Name Nyckel Obligatorisk Typ Description
Åtgärds-ID
 parent_id True string

Systempost-ID för åtgärden som är associerad med den bifogade filen.
Typ
 type True string

Typ av bifogad fil. Fysiska bifogade filer laddas upp filer som bilder, PDF-filer eller Word-dokument som sparas lokalt eller i nätverket. De lagras och hanteras i systemet. Länkbilagor är länkar till filer som bilder, blogginlägg eller YouTube-videor som är online eller i ett molnlagringskonto. De lagras och hanteras externt.
Namn
 name string

Namnet på den bifogade filen. Teckengräns: 150.
Date
 date date-time

Datumet för den bifogade filen (till ex: "2020-09-18T04:13:56Z"). Det här fältet är standardvärdet för aktuellt datum och tid om det inte anges.
URL
 url string

URL:en för den bifogade filen. Detta krävs för länkbilagor och gäller inte för fysiska bifogade filer.
Filnamn
 file_name string

Namnet på filen. Teckengräns: 36. Endast för fysiska bifogade filer.
Fil-ID
 file_id string

Identifieraren för filen. Teckengräns: 36. Endast för fysiska bifogade filer.
Miniatyr-ID
 thumbnail_id string

Identifieraren för miniatyrbilden. Teckengräns: 36. Endast för fysiska bifogade filer.
Etiketter
 tags array of string

Taggarna som är associerade med den bifogade filen.

Returer

Bifogad åtgärd har skapats

Body
ConstituentApi.CreatedActionAttachment

Skapa en komponentåtgärd

Åtgärds-ID:
CreateAction

Skapar en ny komponentåtgärd.

Parametrar

Name Nyckel Obligatorisk Typ Description
Komponent-ID
 constituent_id True string

Systempost-ID för den komponent som är associerad med åtgärden.
Date
 date True date-time

Åtgärdsdatumet (till ex: '2020-09-18T04:13:56Z').
Kategori
 category True string

Kanalen eller avsikten med den konstituerande interaktionen.
Typ
 type string

Ytterligare beskrivning av åtgärden för att komplettera kategorin.
Sammanfattning
 summary string

Den korta beskrivningen av åtgärden som visas överst i posten. Teckengräns: 255.
Anmärkning
 description string

Den detaljerade förklaring som beskriver åtgärdssammanfattningen.
Fullbordad?
 completed boolean

Har åtgärden slutförts? Om systemet har konfigurerats för att använda anpassade åtgärdsstatusar baseras det här värdet på värdet för åtgärdsstatus.
Slutförd den
 completed_date date-time

Det datum då åtgärden slutfördes (till exempel "2020-09-18T04:13:56Z").
Läge
 status string

Åtgärdsstatus.
Direction
 direction string

Åtgärdens riktning.
Plats
 location string

Platsen för åtgärden.
Affärsmöjlighets-ID
 opportunity_id string

Systempost-ID för den affärsmöjlighet som är associerad med åtgärden.
Outcome
 outcome string

Resultatet av åtgärden.
Priority
 priority string

Åtgärdens prioritet.
Starttid
 start_time string

Starttiden för åtgärden. Använder 24-timmars tid i formatet HH:mm.
Sluttid
 end_time string

Sluttiden för åtgärden. Använder 24-timmars tid i formatet HH:mm.
Author
 author string

Författaren till åtgärdens sammanfattning och beskrivning. Om det inte anges har du en standarduppsättning baserat på användarens konto. Teckengräns: 50.
Insamling(er)
 fundraisers array of string

Uppsättningen systempost-ID:t för de insamlingar som är associerade med åtgärden.

Returer

Åtgärden har skapats

Body
ConstituentApi.CreatedAction

Skapa ett anpassat åtgärdsfält

Åtgärds-ID:
CreateActionCustomField

Skapar ett nytt anpassat åtgärdsfält.

Parametrar

Name Nyckel Obligatorisk Typ Description
body
 body True dynamic

Ett objekt som representerar det anpassade fält som ska skapas.

Returer

Anpassat åtgärdsfält skapades

Body
ConstituentApi.CreatedActionCustomField

Uppdatera en bifogad åtgärd

Åtgärds-ID:
EditActionAttachment

Uppdaterar en bifogad åtgärd.

Parametrar

Name Nyckel Obligatorisk Typ Description
ID för bifogad fil
 attachment_id True string

Systempost-ID för den bifogade filen som ska uppdateras.
Namn
 name string

Namnet på den bifogade filen. Teckengräns: 150.
Date
 date date-time

Datumet för den bifogade filen (till ex: "2020-09-18T04:13:56Z").
URL
 url string

URL:en för den bifogade filen. Detta krävs för länkbilagor och gäller inte för fysiska bifogade filer.
Etiketter
 tags array of string

Taggarna som är associerade med den bifogade filen.

Uppdatera en komponentåtgärd

Åtgärds-ID:
EditAction

Uppdaterar en komponentåtgärd.

Parametrar

Name Nyckel Obligatorisk Typ Description
Åtgärds-ID
 action_id True string

Systempost-ID för åtgärden som ska uppdateras.
Date
 date date-time

Åtgärdsdatumet (till ex: '2020-09-18T04:13:56Z').
Kategori
 category string

Kanalen eller avsikten med den konstituerande interaktionen.
Typ
 type string

Ytterligare beskrivning av åtgärden för att komplettera kategorin.
Sammanfattning
 summary string

Den korta beskrivningen av åtgärden som visas överst i posten. Teckengräns: 255.
Anmärkning
 description string

Den detaljerade förklaring som beskriver åtgärdssammanfattningen.
Fullbordad?
 completed boolean

Har åtgärden slutförts? Om systemet har konfigurerats för att använda anpassade åtgärdsstatusar baseras det här värdet på värdet för åtgärdsstatus.
Slutförd den
 completed_date date-time

Det datum då åtgärden slutfördes (till exempel "2020-09-18T04:13:56Z").
Läge
 status string

Åtgärdsstatus.
Direction
 direction string

Åtgärdens riktning.
Plats
 location string

Platsen för åtgärden.
Affärsmöjlighets-ID
 opportunity_id string

Systempost-ID för den affärsmöjlighet som är associerad med åtgärden.
Outcome
 outcome string

Resultatet av åtgärden.
Priority
 priority string

Åtgärdens prioritet.
Starttid
 start_time string

Starttiden för åtgärden. Använder 24-timmars tid i formatet HH:mm.
Sluttid
 end_time string

Sluttiden för åtgärden. Använder 24-timmars tid i formatet HH:mm.
Insamling(er)
 fundraisers array of string

Uppsättningen systempost-ID:t för de insamlingar som är associerade med åtgärden.

Uppdatera ett anpassat åtgärdsfält

Åtgärds-ID:
EditActionCustomField

Uppdaterar ett anpassat åtgärdsfält.

Parametrar

Name Nyckel Obligatorisk Typ Description
Anpassat fält-ID
 custom_field_id True string

Systempost-ID för det anpassade fält som ska uppdateras.
body
 body True dynamic

Ett objekt som representerar egenskaperna för det anpassade fält som ska uppdateras.

Visa anpassade fält för liståtgärd

Åtgärds-ID:
ListActionCustomFields

Visar en lista över anpassade fält för en åtgärd.

Parametrar

Name Nyckel Obligatorisk Typ Description
Åtgärds-ID
 action_id True string

Åtgärdens systempost-ID.

Returer

Anpassade fält

Body
ConstituentApi.ApiCollectionOfActionCustomFieldRead

Definitioner

ConstituentApi.ActionAttachmentRead

Bilaga

Name Sökväg Typ Description
ID-nummer
 id string

Systempost-ID för den bifogade filen.
Åtgärds-ID
 parent_id string

Systempost-ID för åtgärden som är associerad med den bifogade filen.
Typ
 type string

Typ av bifogad fil. Fysiska bifogade filer laddas upp filer som bilder, PDF-filer eller Word-dokument som sparas lokalt eller i nätverket. De lagras och hanteras i systemet. Länkbilagor är länkar till filer som bilder, blogginlägg eller YouTube-videor som är online eller i ett molnlagringskonto. De lagras och hanteras externt.
Namn
 name string

Namnet på den bifogade filen. Teckengräns: 150.
Date
 date date-time

Datumet för den bifogade filen.
URL
 url string

URL:en för den bifogade filen. Detta krävs för länkbilagor och gäller inte för fysiska bifogade filer.
Filnamn
 file_name string

Namnet på filen. Teckengräns: 36. Endast för fysiska bifogade filer.
Fil-ID
 file_id string

Identifieraren för filen. Teckengräns: 36. Endast för fysiska bifogade filer.
Miniatyr-ID
 thumbnail_id string

Identifieraren för miniatyrbilden. Teckengräns: 36. Endast för fysiska bifogade filer.
URL för miniatyr
 thumbnail_url string

URL:en för en miniatyrbild. För fysiska bifogade filer som endast är bilder. Innehåller en tidsbunden signatur som begränsar åtkomsten till 60 minuter.
Innehållstyp
 content_type string

Innehållstypen. Endast för fysiska bifogade filer.
Filstorlek
 file_size integer

Filstorleken i byte. Endast för fysiska bifogade filer.
Etiketter
 tags array of string

Taggarna som är associerade med den bifogade filen.

ConstituentApi.ActionCustomFieldRead

Anpassat fält

Name Sökväg Typ Description
ID-nummer
 id string

Systempost-ID för det anpassade fältet.
Åtgärds-ID
 parent_id string

Systempost-ID för åtgärden som är associerad med det anpassade fältet.
Kategori
 category string

Den anpassade fältkategorin.
Typ
 type string

Den typ av data som det anpassade fältet representerar.
Värde
 value

Värdet för det anpassade fältet.
Textvärde
 text_value string

Textvärdet för det anpassade fältet.
Talvärde
 number_value integer

Det numeriska värdet för det anpassade fältet.
Datumvärde
 date_value date

Datumvärdet för det anpassade fältet.
Valutavärde
 currency_value double

Valutavärdet för det anpassade fältet.
Booleskt värde
 boolean_value boolean

Det booleska värdet för det anpassade fältet.
Tabellpostvärde
 codetableentry_value string

Tabellinmatningsvärdet för det anpassade fältet.
Värde för komponent-ID
 constituentid_value string

Det anpassade fältets komponent-ID-värde.
dag
 fuzzydate_value.d integer

Dagen i fuzzy datum.
månad
 fuzzydate_value.m integer

Månaden i fuzzy-datumet.
år
 fuzzydate_value.y integer

Året i fuzzy datum.
Date
 date date

Datumet för det anpassade fältet.
Comment
 comment string

Kommentaren till det anpassade fältet. Teckengräns: 50.
Datum har lagts till
 date_added date-time

Det datum då det anpassade fältet skapades.
Ändrad datum
 date_modified date-time

Datumet då det anpassade fältet senast ändrades.

ConstituentApi.ActionRead

Åtgärd

Name Sökväg Typ Description
ID-nummer
 id string

Åtgärdens systempost-ID.
Komponent-ID
 constituent_id string

Systempost-ID för den komponent som är associerad med åtgärden.
Kategori
 category string

Kanalen eller avsikten med den konstituerande interaktionen.
Fullbordad?
 completed boolean

Har åtgärden slutförts? Om systemet har konfigurerats för att använda anpassade åtgärdsstatusar baseras det här värdet på värdet för åtgärdsstatus.
Slutförd den
 completed_date date-time

Datumet då åtgärden slutfördes.
Date
 date date-time

Åtgärdsdatum.
Anmärkning
 description string

Den detaljerade förklaring som beskriver åtgärdssammanfattningen.
Direction
 direction string

Åtgärdens riktning.
Insamling(er)
 fundraisers array of string

Uppsättningen systempost-ID:t för de insamlingar som är associerade med åtgärden.
Plats
 location string

Platsen för åtgärden.
Affärsmöjlighets-ID
 opportunity_id string

Systempost-ID för den affärsmöjlighet som är associerad med åtgärden.
Outcome
 outcome string

Resultatet av åtgärden.
Priority
 priority string

Åtgärdens prioritet.
Starttid
 start_time string

Starttiden för åtgärden. Använder 24-timmars tid i formatet HH:mm.
Sluttid
 end_time string

Sluttiden för åtgärden. Använder 24-timmars tid i formatet HH:mm.
Läge
 status string

Åtgärdsstatus.
Statuskod
 status_code string

Åtgärdsstatuskoden. Den här egenskapen returneras endast när systemet är konfigurerat att använda anpassade åtgärdsstatusar.
Beräknad status
 computed_status string

Den beräknade åtgärdsstatusen. Om systemet inte är konfigurerat för att använda anpassade åtgärdsstatusar beräknar det här fältet statusen baserat på de slutförda egenskaperna och datumegenskaperna. Annars beräknar fältet statusen baserat på åtgärdens datumegenskap och om åtgärdens åtgärdsstatusegenskap har konfigurerats som slutförd.
Sammanfattning
 summary string

Den korta beskrivningen av åtgärden som visas överst i posten. Teckengräns: 255.
Typ
 type string

Ytterligare beskrivning av åtgärden för att komplettera kategorin.
Datum har lagts till
 date_added date-time

Datumet då åtgärden skapades.
Ändrad datum
 date_modified date-time

Datumet då åtgärden senast ändrades.

ConstituentApi.ApiCollectionOfActionAttachmentRead

Attachments

Name Sökväg Typ Description
Räkna
 count integer

Antalet objekt som är tillgängliga för hämtning i samlingen när du har tillämpat några begäransparametrar. Parametrarna gräns och förskjutning påverkar inte antalet, men för att underlätta växlingen kan de påverka antalet objekt i värderesultatuppsättningen.
värde
 value array of ConstituentApi.ActionAttachmentRead

Den uppsättning objekt som ingår i svaret. Detta kan vara en delmängd av objekten i samlingen.

ConstituentApi.ApiCollectionOfActionCustomFieldRead

Anpassade fält

Name Sökväg Typ Description
Räkna
 count integer

Antalet objekt som är tillgängliga för hämtning i samlingen när du har tillämpat några begäransparametrar. Parametrarna gräns och förskjutning påverkar inte antalet, men för att underlätta växlingen kan de påverka antalet objekt i värderesultatuppsättningen.
värde
 value array of ConstituentApi.ActionCustomFieldRead

Den uppsättning objekt som ingår i svaret. Detta kan vara en delmängd av objekten i samlingen.

ConstituentApi.ApiCollectionOfActionRead

Åtgärder

Name Sökväg Typ Description
Räkna
 count integer

Antalet objekt som är tillgängliga för hämtning i samlingen när du har tillämpat några begäransparametrar. Parametrarna gräns och förskjutning påverkar inte antalet, men för att underlätta växlingen kan de påverka antalet objekt i värderesultatuppsättningen.
värde
 value array of ConstituentApi.ActionRead

Den uppsättning objekt som ingår i svaret. Detta kan vara en delmängd av objekten i samlingen.

ConstituentApi.CreatedAction

Åtgärden har skapats

Name Sökväg Typ Description
ID-nummer
 id string

ID för den nyligen skapade åtgärden.

ConstituentApi.CreatedActionAttachment

Bifogad åtgärd har skapats

Name Sökväg Typ Description
ID-nummer
 id string

ID:t för den nyligen skapade åtgärdsbilagan.

ConstituentApi.CreatedActionCustomField

Anpassat åtgärdsfält skapades

Name Sökväg Typ Description
ID-nummer
 id string

ID för det nyligen skapade åtgärdsanpassade fältet.