API: Creating Records

From Charitylog Manual
Revision as of 16:44, 29 November 2024 by Emilewhite (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Go to API overview

To create a new record, you will need to do what is referred to as a [PUT] request. For the [PUT] request to work, it relies on having fields within the body of the record. Most of of those will be mandatory fields.

Create a client:

[PUT] https://api.dizions.co.uk/v2/clients

Create a client using an external ID (e.g if a client is also recorded in another system):

[PUT] https://api.dizions.co.uk/v2/clients/external_id/EXTERNAL_ID

Create a referral (Also known as Record a Contact):

[PUT] https://api.dizions.co.uk/v2/referrals

Create a due contact (incomplete action) for a referral:

[PUT] https://api.dizions.co.uk/v2/due_contacts/referral/REFERRAL_ID