Difference between revisions of "API: Creating Records"

From Charitylog Manual
Jump to: navigation, search
Line 7: Line 7:
 
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 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://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://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
  
 
----
 
----

Revision as of 13:03, 13 May 2020

Go to API overview

Helpheader small.png

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