Skip to main content

Activities via the API

Learn how to add, retrieve, update, and delete Activities using the API, including how to work with tasks and activities linked to RPIs.

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

Add Activities Linked to RPIs

  1. Use the endpoint:
    ​ https://data.donorfy.com/api/v1/<apikey>/rpis/<rpiid>/AddActivity

  2. Add the activity to the RPI, then use the standard Activities endpoints described below for any further updates.

Retrieve Activities for a Constituent

  1. Send a GET request to:
    ​https://data.donorfy.com/api/v1/<apikey>/constituents/<constituentid>/Activities

  2. Review the returned list of all activities linked to the constituent.

📌 Note: The response includes each Activity Id, which is required for updates or deletions.

Add an Activity

  1. Send a post request to:
    ​ https://data.donorfy.com/api/v1/<apikey>/Activities

  2. Pass a valid Activity Type, then link the activity to a constituent by providing an Existing Constituent Id if the constituent already exists.

  3. Create a new constituent and activity together by passing a Constituent Type plus any available name or contact details.

  4. Allow the system to set Activity Date automatically, or pass a value to override it.

📌 Note: If you include both Existing Constituent Id and constituent details (such as last name), only the Existing Constituent Id is used. Update constituent details separately if required.

Retrieve an Activity

  1. Send a GET request to:
    ​https://data.donorfy.com/api/v1/<apikey>/Activities/<activity id>/

  2. Review the returned activity details and any linked task information.

Update an Activity

  1. Send a PUT request to:
    ​https://data.donorfy.com/api/v1/<apikey>/Activities/<activity id>/

  2. Include any fields you want to update, such as activity type, date, or details.

📌 Note: Only fields included in the request body are updated.

Delete an Activity

  1. Send a DELETE request to:
    ​ https://data.donorfy.com/api/v1/<apikey>/Activities/<activity id>/

  2. Confirm that you intend to delete the activity, as this action cannot be reversed.

📌 Note:
Deleting an activity also removes any linked task information.

Add a Task When Creating an Activity

  1. Include at least one of the following properties in your post request:
    ​Task Details, Task Assigned To Email, Task Due Date, or Task Completed.

  2. Ensure the Task Assigned To Email value matches the email of an existing Donorfy user.

  3. Set Task Completed to true to mark the task completed; the system assigns the completion date automatically.

  4. Use Task Send Notification to trigger a notification email if your Donorfy is connected to your email server.

📌 Note: If a task notification email fails to send, the activity and task are still created. The API response includes any email error details.

Related Articles
Connections via the API
Lookups and Campaigns Using the API
Work with Constituents Using the API
Manage Gift Aid Declarations Using the API
Use Lists via the API
Did this answer your question?