Skip to main content

Manage Gift Aid Declarations Using the API

Create, retrieve, update, and cancel Gift Aid Declarations for constituents through the Donorfy API.

Cristina Gruita avatar
Written by Cristina Gruita
Updated over a month ago

Add a Gift Aid Declaration

You can add a new Gift Aid Declaration to an existing constituent using a POST request.

  1. Include the required declaration details in the request body.

The request body must include:

  1. A valid Declaration Method.

  2. Declaration date, state, and end date.

  3. Taxpayer first name and last name, each up to 35 characters.

If you include a campaign or department, the value must already exist in Donorfy.


Retrieve Gift Aid Declarations

You can retrieve all Gift Aid Declarations for a constituent using a GET request.

  1. Review the list of returned declarations.

Filter by Date Range

  1. Add decStartDate and decEndDate query parameters.

  2. Use dates in YYYY-MM-DD format.

Date filtering helps when auditing declarations over a specific period.


Update a Gift Aid Declaration

Existing Gift Aid Declarations can be updated using a PUT request.

  1. Include only the properties you want to change.

Properties not included in the request remain unchanged.


Cancel a Gift Aid Declaration

You can cancel an active Gift Aid Declaration using a dedicated endpoint.

Cancelling a declaration:

  1. Sets the cancellation date to the current system date.

  2. Marks the declaration as cancelled in Donorfy.

Cancelled declarations are retained for audit purposes and are not deleted.


Understand Validation Rules

Gift Aid Declaration requests must meet Donorfy validation requirements.

  1. Declaration methods must be valid.

  2. Campaign and department values must exist in Donorfy.

  3. Name fields must not exceed character limits.

Invalid values cause the request to fail or the affected property to be ignored.

⚠️Important:
The Donorfy API is a Professional-only feature. Essential subscribers, please contact us to find out more about upgrading.

Did this answer your question?