Beyond the Setup pages in the Console, an integration can read and write funds, fund categories, campaigns, appeals, and fundraising products directly. It also has a few capabilities the Console does not offer.
What This Controls
This article covers three integration-only capabilities for designations: making many changes in one request, listing the products that belong to one fund, and keeping custom field values. It also explains the account boundary that applies to all of these requests.
Batch Requests
An integration can send many designation changes in one request, including any mix of funds, fund categories, products, campaigns, and appeals. Rhythm validates and applies each operation separately, then reports each result separately, so one failed operation does not stop the others from succeeding.
The Console does not offer an equivalent way to make several designation changes at once. Batch requests are useful when you are loading or correcting many funds, campaigns, or appeals from an external system.
Custom Field Values
Funds, campaigns, and appeals keep the custom field values your account has defined for them, whether you read or write those values through the Console or through an integration. Fund categories are the exception because they do not accept custom field values.
Listing a Fund's Products
An integration can list every fundraising product that belongs to one fund. The Console does not have a screen for this specific view. The Manage Fundraising Products page lists every product across your whole account, not products grouped by fund, so this view is available only through an integration today.
Use this list to confirm which products exist for a fund before you make further changes to it, including the product Fundraising creates automatically to match the fund itself.
Account Boundaries
| Caller | What happens |
|---|---|
| A request naming your own Rhythm account | Processed normally |
| A request naming a different Rhythm account | Refused |
| A session with no account context, or a partner request identified only by an API key | Treated as acting for the account named in the request |
A campaign’s list of appeals and a fund’s list of products are also limited to your own Rhythm account. An integration can never pull another account’s appeals or products by asking for them against a campaign or fund that is not yours.
Warning
This account boundary applies to the whole request. If your integration serves more than one Rhythm account, make each request in the context of the correct account instead of relying on one shared session to keep the accounts separated.