Tags allow you to add classifications, such as interests, mailing groups, or exclusions, to Constituents. Using the API, you can add or remove both Active Tags and Excluded Tags when creating or updating Constituents or timeline items (e.g., Transactions).
How Tags Are Passed to the API
Tags are provided through two properties:
Active Tags:Tags the Constituent should have in an active state.
Excluded Tags: Tags the Constituent should have in an excluded state (e.g., opt-outs).
Work with Tags
Get all active tags by calling https://data.donorfy.com/api/v1/<your api key>/constituents/<id>/ActiveTags
Get all excluded tags by calling https://data.donorfy.com/api/v1/<your api key>/constituents/<id>/ExcludedTags
To add an active tag https://data.donorfy.com/api/v1/<your api key>/constituents/<id>/AddActiveTags
To add an excluded tag https://data.donorfy.com/api/v1/<your api key>/constituents/<id>/AddExcludedTags
📌Note:
When adding Active or Excluded tags, Donorfy automatically removes the same tag from the opposite list to avoid duplication.
To remove a tag you can use:
https://data.donorfy.com/api/v1/<your api key>/constituents/<id>/RemoveTag - passing in one tag description prefixed with its category.
⚠️Important:
The Donorfy API is a Professional only feature. Essential subscribers, please contact us to find out more about upgrading.