Difference between revisions of "API: Creating Records"
From Charitylog Manual
m (Msim moved page Creating Records Via The API to API: Creating Records) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
[[API Details| Go to API overview]] | [[API Details| Go to API overview]] | ||
| − | |||
| − | |||
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. | 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. | ||
| Line 7: | Line 5: | ||
Create a client: | Create a client: | ||
| − | [PUT] https<nowiki/>://api.dizions.co.uk/v2/clients | + | [PUT] https<nowiki/>://api.dizions.co.uk/v2/clients |
Create a client by an external ID (e.g a reference to the client in another system): | Create a client by an external ID (e.g a reference to the client in another system): | ||
| − | [PUT] https<nowiki/>://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 (Record a Contact): | ||
| − | [PUT] https<nowiki/>://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<nowiki/>://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 10:19, 20 May 2024
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.
Create a client:
[PUT] https://api.dizions.co.uk/v2/clients
Create a client by an external ID (e.g a reference to the client in another system):
[PUT] https://api.dizions.co.uk/v2/clients/external_id/EXTERNAL_ID
Create a referral (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
