Issues creating a new gift with a custom field through the Gift API

Dylan Hochreiter
Dylan Hochreiter
Fifth Anniversary Kudos 1 Name Dropper Participant
in Blackbaud Raiser's Edge NXT® APIs

Hello there,

I am working on an integration in our application to allow the creating of one time and recurring gifts through the Gift API into NXT. I am working with the Cohort Sandbox environment while I develop this feature.

I am able to create one time and recurring gifts through the API, but I am running into an issue when attempting to add a gift with an attached custom field.

When adding a custom field, I first pull the custom field category list and check if the category I am referencing exists already, if not I create it through the “gifts/customfields/categories” endpoint.

I then use either the existing category name, or the one I just created when creating the gift with the custom field.

The issue that then happens is that I get an exception/error response from the API stating: "The category of this custom field cannot be found.". The error code that is returned is 1001.

I guess my confusion is that I am grabbing the category name directly from the existing category list that I pulled from the API, so it doesn't make much sense that I would receive this type of error.

Any and all help would be much appreciated.


Thanks,


Dylan Hochreiter

Comments

  • Anthony Gallo
    Anthony Gallo Blackbaud Employee
    Tenth Anniversary Kudos 3 Name Dropper Participant

    It looks like we require the "category" field to be the integer system record id of the Custom Field type. If the type is a CodeTable or Constituent type, then the "value" field must also be the integer system record id of the CodeTable entry or Constituent record. This is not correctly noted in the API documentation and the documentation needs to be updated. Sorry for any confusion here.

    There are Data Integration endpoints that will return these values.
    Get custom field category list will return the Custom Field Category System ID.
    For Code Table Types, you then use the Code Table ID from the previous call to the Data Integration Get Table Entries list EP to return the Table Entries ID that will be needed for the value field.

  • Dylan Hochreiter
    Dylan Hochreiter
    Fifth Anniversary Kudos 1 Name Dropper Participant

    You were correct that the system ID was needed for this.

    I was able to use the “Adds custom field Category (GetOrCreate)” endpoint, which returned the ID I needed to create the custom field and attach it to the gift I was creating.

    Thanks for the help with this Anthony.

Categories