Difference between revisions of "API: Creating Records"
From Charitylog Manual
(Created page with "right To create a record you need to do a [PUT] request, with fields in the body. Many of these will have a selection of mandatory fields. Crea...") |
Emilewhite (talk | contribs) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[ | + | [[API Details| Go to API overview]] |
| − | To create a record you need to do a [PUT] request, | + | 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: | Create a client: | ||
| − | [PUT] https://api.dizions.co.uk/v2/clients | + | [PUT] https<nowiki/>://api.dizions.co.uk/v2/clients |
| − | Create a client | + | 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 | + | [PUT] https<nowiki/>://api.dizions.co.uk/v2/clients/external_id/EXTERNAL_ID |
| − | Create a referral (Record a Contact): | + | Create a referral (Also known as Record a Contact): |
| − | [PUT] https://api.dizions.co.uk/v2/referrals | + | [PUT] https<nowiki/>://api.dizions.co.uk/v2/referrals |
Create a due contact (incomplete action) for a referral: | Create a due contact (incomplete action) for a referral: | ||
| − | [PUT] https://api.dizions.co.uk/v2/due_contacts/referral/REFERRAL_ID | + | [PUT] https<nowiki/>://api.dizions.co.uk/v2/due_contacts/referral/REFERRAL_ID |
---- | ---- | ||
Latest revision as of 16:44, 29 November 2024
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
