API done contacts

From Charitylog Manual
Jump to: navigation, search

Go to API overview

These are completed actions, which are equivalent to the top half of Record a Contact in the web application. They are created like this, using the referral number

[POST] https://api.dizions.co.uk/v2/done_contacts/referral/127

This will return the id, which can be used for editing, like this:

[POST] https://api.dizions.co.uk/done_contacts/456

The body must contain all of the following keys for creation, and at least one for editing: user, stage, start_date, end_date and description.

NB the done_contact is also used to complete a due_contact, because conceptually, you are converting a due_contact into a done_contact when completing it. Also see the page on due_contacts