Bump: Custom fields creation issue with Gift (Batch) POST endpoint - Custom field category name doesn't work, id does?

Qgiv Product
Qgiv Product
Third Anniversary Name Dropper Facilitator 1
in Blackbaud Raiser's Edge NXT® APIs

When using the Gift Batch creation endpoint, we're noticing that we're required to use the custom category id, versus custom category name. For constituent creation though, we are able to use the custom category name.

Is this a bug with the gift batch creation endpoint, or is it intended? If intended, how do we go about getting the gift custom category ids (without using the elevated permissions required by the NXT Data Integration endpoint)?

(in addition, could the documentation be updated to specify what exactly is required? Right now, it doesn't specify category name vs category id)

Original issue being bumped:

Comments

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

    This is the current functionality and we are aware that it is different in a couple spots. We have plans to eventually add the ID part to get back in sync (but we would not take away the name match for risk of a breaking change). At this time there is no timeline as to when we would be able to get that added.

  • Qgiv Product
    Qgiv Product
    Third Anniversary Name Dropper Facilitator 1

    Great, thank you for the update @Anthony Gallo !

    I do think the matching via name for constituents is actually how we prefer it to work; since the ListConstituentCustomFieldCategoryDetails endpoint (

    ) only returns names and type anyways (does not return ids).

    The problem that we have with the Gift Custom Field creation however is I'm not aware of any way to obtain the custom field category ids with a non-privileged api user. The endpoint I'm trying to use, ListGiftCustomFieldCategories (

    ), also only returns names and type (does not return ids).

    If the gift batch endpoint requires ids (versus names), but I have no way programmatically to get those ids, I'm not quite sure how I can properly format my request. (without just excluding the feature to map to gift custom fields)

    I did see that in https://community.blackbaud.com/forums/viewtopic/494/58774 you mentioned using the NXT Data Integration endpoints, but those endpoints currently require environment admin permissions that we're trying to avoid needing to use with our integration.

    Would it either be possible to make ids available in both ListConstituentCustomFieldCategoryDetails and ListGiftCustomFieldCategories? Or alternatively allowing the batch gift endpoint to operate on both id and name for custom field categories?

  • Qgiv Product
    Qgiv Product
    Third Anniversary Name Dropper Facilitator 1

    For anyone following along here, we have opened up an Idea for this requested endpoint modification:

  • Szymon Zaleski
    Szymon Zaleski
    Seventh Anniversary Kudos 1 Name Dropper Participant

    @Qgiv Product upvoted.

    Not only it requires category in form of ID rather than name (AttributeTypes table for those who have access to the backend database backup), it also requires ID in the Value field, when the custom field type is Table (Tableentries table). It's unintuitive, as it is different than Constituent custom fields, where both Category and Value are passed as strings.

Categories