Difference between revisions of "API due contacts"

From Charitylog Manual
Jump to: navigation, search
Line 1: Line 1:
 
[[API Details|Go to API overview]]
 
[[API Details|Go to API overview]]
  
These are outstanding actions that typically make up the Action List in the web application.
+
These are outstanding actions that typically make up the Action List in the web application. They are the equivalent of the bottom half of the Record a Contact page.
 +
 
 +
Typically, there are 3 things you might want to do with a due contact:
 +
 
 +
1) Create a due contact against an existing referral
 +
 
 +
[PUT] https<nowiki/>://api.dizions.co.uk/v2/dictionary
 +
 
 +
Add values for user, start_date, end_date and description. Note that as an outstanding action, the start_date and end_date refer to the planned start and end time of the action.
 +
 
 +
2) Edit an existing due contact, e.g. if you want to reassign the action to a different

Revision as of 12:13, 12 August 2021

Go to API overview

These are outstanding actions that typically make up the Action List in the web application. They are the equivalent of the bottom half of the Record a Contact page.

Typically, there are 3 things you might want to do with a due contact:

1) Create a due contact against an existing referral

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

Add values for user, start_date, end_date and description. Note that as an outstanding action, the start_date and end_date refer to the planned start and end time of the action.

2) Edit an existing due contact, e.g. if you want to reassign the action to a different