Skip to main content

Fixed: POST /api/Raise/lead creates leads again

POST /api/Raise/lead now records a lead without a page and returns 200 OK. Before, every request failed with an empty 500 Internal Server Error.
  • Attribution fields: the new optional segmentCode, motivationCodeId and motivationCodeGroupId attribute the lead. Raise resolves them within your organization.
  • Premium fields: the new optional premiumId, premiumVariantId and premiumOverrideCode attach a free premium to the lead, with a quantity of 1. premiumVariantId is ignored unless you send premiumId. A premiumOverrideCode that matches no free, in-stock premium is ignored, and it’s ignored when you send premiumId.
  • Validation: the request returns 400 Bad Request with an error on the field at fault when donor is missing (“Donor is required.”), when motivationCodeId, motivationCodeGroupId or segmentCode doesn’t resolve, or when the premium isn’t available, the variant isn’t one of its variants, or the premium is out of stock (errors on Premium). Other rejected submissions return 400 Bad Request with “The lead could not be submitted.”
  • Unexpected failures: the response is 500 Internal Server Error with a ProblemDetails body titled “The lead could not be submitted” and a traceId to include when you contact support.
  • Confirmation email: a lead without a page sends the confirmation email to the donor only. Raise doesn’t send a team notification.
This is an additive change; no existing fields changed or were removed. See Error Handling.

Fixed: premiumId attaches the premium to a donation

POST /api/Raise/give now attaches the premium you send in premiumId to the gift, including when the request starts a recurring gift. Before, Raise accepted the field but dropped it, and the gift was created with no premium and no error.
  • premiumVariantId and quantity: two new optional fields that pick the premium’s variant and how many the donor selected. quantity defaults to 1.
  • Validation: sending premiumVariantId or quantity without premiumId returns 400 Bad Request with an error on PremiumId, and a quantity below 1 returns 400 Bad Request with an error on Quantity. The payment method isn’t charged.
  • X-Raise-Ignored-Fields header: when the request body includes fields Raise doesn’t recognize, the response lists their names, comma-separated. Raise still ignores those fields.
Requests that already sent premiumId will now attach a premium, so the existing premium rules (for example, the gift amount covering the premium’s minimum) apply to them. No existing fields changed or were removed. See Gifts.

Added: Filter webhook logs by time of day

You can now narrow the webhook log date range to the minute, for example to find the deliveries that failed during a short outage.
  • TimeFrom and TimeTo query parameters: GET /api/Webhook/log/list and GET /api/Webhook/{id}/log/list accept an optional start time on DateFrom and end time on DateTo, read in the organization’s timezone. The TimeTo minute is included. A time without its date is ignored, and date-only requests return the same results as before.
  • Range validation: both endpoints return 400 Bad Request when the start of the range is at or after its end, instead of an empty page.
  • createdDateTime field: log entries now include the attempt time to the second, in the same timezone the filter uses.
  • Sorting: SortBy=contextid is now supported, and rows that tie on the sort column are ordered by id so paging stays stable.
Requests with an inverted date range that returned an empty page now return 400; no fields were removed. See Filtering by date and time.

Changed: Search webhook logs by gift ID

You can now find every webhook delivery for a gift by searching the webhook logs for its ID, including manual resends.
  • Numeric Filter: on GET /api/Webhook/log/list and GET /api/Webhook/{id}/log/list, a number now matches contextId, the ID of the gift, donor or other record the delivery was for. A number from 100 to 599 also matches httpStatusCode, and any number matches webhook names that contain it.
  • Text Filter: text matches the event type by its label (Gift Added) as well as its identifier (Gift_Added), case-insensitive, plus webhook names that contain it.
  • Removed matches: a number no longer matches the log entry’s own id or event types by their numeric value.
If you searched for a log entry by its id, search by contextId instead or fetch the entry with GET /api/Webhook/{id}/log/{logId}. No fields changed or were removed. See Searching logs.

Added: Filter webhook logs to failed deliveries

You can now list only failed webhook deliveries instead of paging through every successful one.
  • Success query parameter: GET /api/Webhook/log/list and GET /api/Webhook/{id}/log/list accept an optional boolean Success. Success=false returns only failed deliveries, Success=true returns only successful ones, and omitting it returns both.
  • Totals and paging: total and paging reflect the filter. It combines with Filter and the date range.
This is an additive change; no existing fields changed or were removed. See Retry Behavior.

Added: Set the email address a recurring gift’s emails go to

Raise now sends a recurring gift’s emails to the address stored on the schedule, so a later gift with a different email no longer moves them.
  • Stored address: a recurring gift set up through POST /api/Raise/give stores the donor email from that request. Charge receipts, upcoming-charge reminders, and update, cancellation and failed-charge emails go to it. A schedule with no stored address falls back to the email recorded with the charge, then the donor’s primary email.
  • email on PATCH /api/RecurringGift/{id}: an optional field that changes the stored address. It must be a valid email address of at most 150 characters, or the request returns 400 Bad Request. A PATCH without email, or a PUT, keeps the stored address.
  • Opt-in: Raise checks opt-in against the address it’s emailing. An address that isn’t one of the donor’s email addresses is emailed only when email isn’t suppressed for the donor and their primary email is opted in.
email isn’t returned on the recurring gift. See Recurring Gifts.

Changed: Legacy query endpoints are deprecated

The query-builder endpoints and the saved-query endpoints are deprecated. They keep working with no change in behavior, and the API reference now marks them deprecated.
  • Affected endpoints: POST /api/Campaign/query, POST /api/Donor/query, POST /api/Gift/query, POST /api/Project/query, POST /api/RecurringGift/query, POST /api/Segment/query, POST /api/Query, PUT /api/Query/{id}, DELETE /api/Query/{id}, GET /api/Query/list/{queryType}, GET /api/Query/lookup, POST /api/Query/parse, and GET /api/Query/options/{queryType}.
  • Deprecation header: every response from these endpoints carries Deprecation with the deprecation date as Unix seconds, for example Deprecation: @1793750400 (November 4, 2026).
  • Sunset header: Raise will add a Sunset header with the removal date once one is announced. No date is set yet.
  • Replacements: the newer query endpoints, such as POST /api/Query/{entity}/execute, are being enabled organization by organization and aren’t in the API reference yet.
No request or response fields changed. See Pagination.

Fixed: Non-base64 recurring gift notes return 400

PUT /api/RecurringGift/{id} expects notes to be a base64-encoded string. A value that isn’t valid base64 now returns 400 Bad Request with an error on Notes: “Notes must be base64 encoded.” Before, the request failed with 500 Internal Server Error.

Fixed: Transfers to the current donor return 400

PUT /api/Donor/transfer-gift and PUT /api/Donor/transfer-recurring-gift now refuse a transfer to the donor who already holds the gift or schedule. Before, the request succeeded and recorded a redundant transfer to the same donor.
  • Gifts: the request returns 400 Bad Request with an error on NextDonorId: “This gift already belongs to that donor. Choose a different donor.”
  • Recurring gifts: the request returns 400 Bad Request with an error on NextDonorId: “This schedule already belongs to that donor. Choose a different donor.”
No request or response fields changed. See Donors.

Breaking: POST /api/Raise/give requires a nonce

Every request to Process a Donation Payment must now include a nonce: a new GUID for each donation. Before, a request without one went through once, and every later donation from the same integration failed with an unexplained error.
  • Missing nonce: the request returns 400 Bad Request with an error on Nonce: “A unique nonce (GUID) is required. Generate a new nonce for each donation request.”
  • Reused nonce: when the payment processor refuses a nonce it has already processed, the request returns 400 Bad Request with a message saying the nonce was most likely already used, instead of a generic retry message.
Action required: Generate a new GUID for each donation and send it as nonce. Keep the same value only when you retry the same donation. See Process a Donation.

Changed: Rate limits are documented, with headers on every response

The Raise API allows 1,500 requests per hour by default, counted per caller and organization in fixed one-hour windows that start on the hour (UTC).
  • Headers: responses carry X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. X-RateLimit-Reset is the Unix time when the current window ends.
  • 429 Too Many Requests: the response carries the same three headers plus Retry-After, the number of seconds until the window ends. The body is plain text, not ProblemDetails.
  • Recovery: requests made while you are limited no longer push the reset time back, so a client that keeps retrying recovers when the window ends.
See Rate Limits.

Changed: Deleted API keys stop working immediately

When a customer deletes an API key in Raise, requests that use its token now return 401 Unauthorized right away. Before, a token issued for a deleted key kept working. See Authentication.

Changed: Stricter webhook targets and delivery

  • Public HTTPS only: POST /api/Webhook and PUT /api/Webhook/{id} return 400 Bad Request when notificationUrl points to localhost, a *.internal or *.local host, or a non-public IP address. Raise also skips delivery, without retrying, when the host resolves to a non-public address.
  • No redirects: Raise no longer follows redirects. A 3xx response is a failed delivery.
  • 15-second timeout: each delivery attempt has 15 seconds to complete, including reading the response.
  • Record permissions: creating or updating a webhook, and reading its delivery logs, now requires View access to the records its event types carry, in addition to Account Settings. Without it, the request returns 403 Forbidden.
See Webhooks Overview and Retry Behavior.

Added: Event IDs and Gift_Added resends

  • eventId: every webhook payload now carries an eventId, also sent in the X-RD-Event-Id header. Retries of a delivery reuse it, so you can use it to deduplicate.
  • Resends: a Raise administrator can resend Gift_Added events to one webhook, for one gift or for every gift created in a date range. Resent deliveries carry a new eventId, isResend: true in the payload and an X-RD-Resend: true header.
  • Webhook logs: log entries now include eventId, isManualResend and triggeredByName.
This is an additive change; no existing payload fields changed or were removed. See Idempotency and Safe Reprocessing.

Improved: Endpoint-specific error documentation

Every error response in the Raise API reference now says what it means for that endpoint, instead of just Bad Request or Not Found.
  • 400 responses name the likely cause — the 116 documented 400 responses now describe what that endpoint rejects: which query parameter was at fault on a list endpoint, which fields the errors map covers on a create or update, and which IDs must be present and distinct on Merge Donors, Transfer a Donor Gift, and the campaign, segment, and project replace endpoints.
  • They say what happened to your data — a 400 on a write means nothing was persisted, so Update a Campaign leaves the stored campaign untouched, a refused refund leaves the gift unchanged, and a refused transfer leaves the gift with its current donor.
  • 400 versus 404 where both apply — on Cancel a Recurring Gift, 400 means the schedule exists but isn’t cancellable (including one that’s already cancelled) and 404 means the ID doesn’t resolve. On the nested donor resources, 404 also covers a child record that belongs to a different donor.
  • 401 is now documented on all 145 endpoints — every Raise endpoint requires Bearer authentication, but none of them declared the 401 it returns when the header is missing or the token is expired or revoked. Each one now documents it with the ProblemDetails body.
  • Endpoints with no documented errors are flagged — Process a Donation Payment, Capture a Lead, the seven Query endpoints, and five others carry a note saying the spec doesn’t enumerate their failure cases, rather than implying they can’t fail.
403, 429, and 500 are still not documented per-endpoint because the spec doesn’t confirm their behavior — Error Handling covers handling them defensively. No paths, schemas, or fields changed.

Improved: Realistic response examples across the API

Every endpoint that returns a body now shows a filled-in example response instead of <string> and 0 placeholders — 112 success responses, plus a worked error example on the 116 endpoints that document a 400 and the 27 that document a 404.
  • One example world — the examples all come from the same fictional nonprofit, Riverside Hope Foundation, and the same donors. Marcus Castellano is donor 200234 in Get a Donor, the donor on gift 602198 in Get a Gift, and the top donor of the YE25-EMAIL segment in List Segment Donors. Priya Sharma’s $50 monthly schedule is recurring gift 700089, the gift it generated on November 15 is 602401, and the two line up in List Recurring Gift Activities.
  • The shapes partners actually handle — List All Gifts shows a recurring instance, an anonymous online gift, and a major gift in one page; List All Donors shows an individual, a monthly donor, and an organization; Cancel a Recurring Gift shows the cancelled schedule the call leaves behind.
  • Endpoint-specific examples — List Donor Phone Numbers shows phone numbers and List Donor Email Addresses shows email addresses, the donor-scoped lists show one donor’s gifts and schedules rather than the organization-wide set, and the campaign, motivation, and segment statistics endpoints each show their own kind of totals.
  • Errors — 400 responses show the errors map with field-level messages for that endpoint, and 404 responses name the record that wasn’t found. Both use the ProblemDetails envelope described in Error Handling.
  • Safe sample data — all names, @example.org addresses, and 555-01XX phone numbers are reserved for documentation, and every date is anchored to a single point in time so the totals and histories agree with each other.
Where an integer enum such as status, frequency, or type still has no published labels, the examples show the accompanying display field — statusText, formattedFrequency, typeDisplay — rather than guess at a value. See Statuses and Lifecycle States.No paths, schemas, fields, or behavior changed — this only affects the examples shown in the docs.

Improved: Described parameters and request and response fields

Every parameter in the Raise API reference now has a description, and the fields you send and read are described in the language of the product rather than the source code.
  • Paging and filtering — skip, take, sortBy, descending, filter, and includeDetails were blank on 27 list endpoints and now read the same everywhere. Each filter says what it searches, and includeDetails says what it adds — the segments, pages, and page statistics on List All Campaigns, the addresses and contact methods on List All Donors, the donor, gateway, and segment on List All Gifts.
  • Path parameters — the 21 {id} parameters that showed nothing now say which record they identify, including the donor an address, contact method, email, or phone belongs to.
  • Payments — the eight query parameters on Calculate Payment Processing Cost are described, and every field of the Process a Donation Payment body is too: nonce versus paymentMethodId, the recurring fields (isRecurring, frequency, startDate, timeZone), the fee-covering fields (donorPaidCosts, coverAdminFee, adminFee), and the tribute and project blocks.
  • List responses — items and total are described on every paged response, including how to use total with skip and take to page through the full set.
  • Errors — the type, title, status, detail, and instance fields of the error response returned across the API are now described.
  • Newly described areas — motivation codes and groups, knowledge sources, tributes, page design settings, currency exchange, campaign goals, premiums, projects, segments, and saved queries.
  • Wording — about 700 field descriptions that started with the source code’s “Gets or sets the…” now read as plain statements, and the ones that said only “the identifier” or “a value indicating whether organization” now say what they mean.
Paths, fields, and operations are unchanged — this only affects the descriptions shown in the docs.

Improved: Consistent endpoint names and cleaned-up wording

Endpoint names across the Raise API reference now follow a consistent verb + concise object pattern, and the wording carried over from the source code has been cleaned up.
  • Names that collided or read vaguely are now specific: the two donor activity endpoints are List Donor Activities (organization-wide) and List Activities for a Donor, the two log endpoints are List All Webhook Logs and List Logs for a Webhook, and Look Up Query Parameter Options is now Get Query Parameter Values, which is what it returns.
  • Check if Segment Exists is now Check if Segment Code Exists, matching the project code endpoint and the code it checks.
  • Run-together words from the source code’s comments are fixed throughout the field descriptions — crmkey, customfield name, entitytypedisplay name, pay load, java script version, tributefirst name, and about 30 more.
  • Descriptions that trailed off mid-sentence now say what the field means — for example, isValid on a donor contact method and canSync on a campaign, and the supports java applets and [active] flags.
  • Schema summaries built from class names now read as English (“Represents a gift transfer request.” instead of “Represents a transfergift request.”), leftover .NET member names are replaced with the JSON field they refer to, and parameter descriptions have consistent sentence punctuation.
Paths, fields, and operations are unchanged — this only affects the names and descriptions shown in the docs.

Improved: Endpoint summaries and descriptions

Every endpoint in the Raise API reference now has a summary and a description explaining what it does — 139 endpoints that previously showed nothing beyond their name, 8 that were unlabeled entirely, and a few whose copy was a leftover developer note.
  • What each endpoint does — each description is a one-line statement of what the call returns or changes. The detail that used to be missing entirely — the fields you most often need to send, what a flag such as includeDetails adds, and the related endpoint to use when there is a better one for the job (Delete a Gift to Refund a Gift, Delete a Premium to Deactivate a Premium, Search Donors to Query Donors) — now appears above the reference on the endpoint page.
  • Callouts — the things worth pausing on are flagged: an Info for the paging, filtering, and “use this other endpoint” pointers, and a Note for the ones that cost you if you miss them — Delete a Gift not refunding the donor, PUT replacing the values you leave out, includeDetails slowing large result sets, and checking a dependency count before a delete.
  • Named endpoints — List All Donors, List All Gifts, List Donor Custom Field Responses, Search Email Lists, Capture a Lead, and the motivation code and motivation code group endpoints are no longer unlabeled in the reference.
  • Queries — every Query endpoint points to Get Query Options for the parameters, operators, and result fields its query type supports, and explains what includeDetails adds to the response.
  • Placeholder copy removed — Query Campaigns no longer shows raw <list> markup and internal class names, and the Update a Donor and Partially Update a Donor descriptions now read like the rest of the reference.
These are documentation-only changes — no paths, schemas, fields, or behavior changed.

New: Raise API Documentation Changelog

We’ve launched the Raise API Documentation Changelog to help developers and partners stay up to date on changes to the Raise API and related documentation.This changelog will include updates such as:
  • New and updated Raise API endpoints
  • Donation, campaign, transaction, and supporter data updates
  • Request and response schema changes
  • New fields, objects, filters, and parameters
  • Deprecation notices and breaking changes
  • Improvements to examples, guides, recipes, and API reference documentation
Last modified on November 17, 2026