API: File Uploads

From Charitylog Manual
Revision as of 15:23, 26 August 2020 by Msim (talk | contribs)
Jump to: navigation, search

Go to API overview

Helpheader small.png

You can upload files against clients and referrals. Like the web application, these are stored on Amazon S3.

[POST] https://api.dizions.co.uk/v2/clients/id/CLIENT_ID/uploads
[POST] https://api.dizions.co.uk/v2/referrals/id/REFERRAL_ID/uploads

In the body you'll need:

  • the files

and optionally:

  • user_visibility, which is a comma separated list of user ids who are allowed to access the files
  • group_visibility, which is a comma separated list of group ids who are allowed to access the files

If a list of users and/or groups is not specified, the files will be visible to all users. To get a list of users, call:

v2/dictionary/user

The user group ids are not currently available in the API. Speak to the support team for advice.