Blackbaud CRM API endpoint to get Designation ID for Recurring Payments

Dylan Hochreiter

Hi there,

We have an existing client that is looking at making the switch over to Blackbaud for their payment processing, and they have asked for an integration with CRM.

We are currently evaluating building this integration in our application with the Blackbaud CRM APIs and I have run into some issues testing with the SKY Developer Console.

I was specifically trying to test with the Recurring Payments endpoint from the Revenue API but I am running into some roadblocks.

When creating a recurring payment, I need a designation ID to include with the gift split I am including in the response body. With the RENXT APIs, we are able to pull the fund designation list from the Fundraising API in order to get IDs to work with.

For CRM, there doesn't appear to be a way to get any Designation ID from a list or search endpoint. In the CRM application, I can use the designation search to find designations, but from those you can only get the Lookup_ID. It seems like for the Revenue API recurringgifts endpoint you need to include the system record ID and not the Lookup ID. Is there any way to get a Designation ID so that I can move forward with testing these API calls in the SKY Developer Console?

Also, are there any plans to add something like the RENXT Fundraising API for CRM in the future?

Any help with this would much appreciated.

Thank you,

Dylan Hochreiter

Ashley Moose

@Dylan Hochreiter You could use the GET Simple list load endpoint (in Administration) to call the Designation Simple Data List which would return a list of all Designations with the Designation name and Designation System Record ID.

If you needed other fields to help filter out and select the needed designation, you could also create a Designation query and include all of the needed fields (plus System Record ID), and call the query output via the GET List adhoc query entries endpoint (in Analysis).

Dylan Hochreiter

@Ashley Moose Thank you for this information. I will give those a try!

Dylan Hochreiter

@Ashley Moose I have a couple of questions related to this.

For the Simple Data List endpoint, it seems that I would need to first create a data list with the Designations in CRM, and then use that System Record ID to call the endpoint you provided. Is that correct?

If that's the case, does that mean that there isn't a way to pull the information on the available designations via the CRM API without first creating a simple data list or adhoc query in CRM?

Your help is much appreciated with this!

Ashley Moose

Hi @Dylan Hochreiter - The GET Simple List Load endpoint allows you to call a Simple data list, not a user defined data list.

Using that search for designations, I see the following potential simple data lists that could be used. While others of these could be useful they likely have additional parameters or limits to prevent from showing all designations. Whereas the Designations Simple Data List just returns all designations.

You would then need to pass this ID through the endpoint to view the results.

Dylan Hochreiter

@Ashley Moose Thanks for this!

I wasn't able to see this as I don't have access to much under Administration in the SKY Developer Cohort CRM environment. I will need to request access for that.

One more clarification, given that this is not user defined, is that System Record ID GUID going to be the same for any account using CRM?

Ashley Moose

@Dylan Hochreiter Yes, since it's not user defined the IDs should be the same. I just compared against a different environment to make sure and the IDs matched.