This article provides information about working with Connections via the API.
You can work with Connections as follows:
- Connections can be added via a post request to the Connections endpoint - a new connection will be added to the constituent identified by {constituentId}.
The endpoint to use is: https://data.donorfy.com/api/v1/<apikey>/constituents/{constituentid}/Connections
The body of your request must include- A valid constituent id in the ConnectedConstituentId property
- The type of connection - which must exist in the list of connection types in your Donorfy
- You can optionally provide
- Connection from and to dates
- Connection strength - which can be a number from 1 to 5
- Connection details - for comments or notes about the connection
- Connections for a constituent can be retrieved via a get request to the https://data.donorfy.com/api/v1/<apikey>/constituents/{constituentid}/Connections endpoint - a list of connections will be returned. The list will include the connection Id for each connection - the connection id is needed when updating or deleting connections
- Connections can be updated via a put request to https://data.donorfy.com/api/v1/<apikey>/constituents/{constituentid}/Connections/{connectionId}/ when updating connections you can change
- Which constituent the connection is to, by passing a constituent id in the ConnectedConstituentId property
- Connection from and to dates
- Connection strength - to clear the connection strength value pass a value of zero
- Connection details
- Connections can be deleted via a delete request to https://data.donorfy.com/api/v1/<apikey>/constituents/{constituentid}/Connections/{connectionId}/
The Donorfy API is a Professional-only feature. Essential subscribers, please contact us to find out more about upgrading.
Comments