ELelicitlabs
Library

Update a collection

Changed on

Updates name and/or description. Omitted fields do not change. A body with neither returns 400. Needs edit access.

Example

curl -X PATCH https://elicit.com/api/v2/library/collections/{collectionId} \
  -H "Authorization: Bearer elk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"description":"Outcome trials, 2016 onward."}'
patch/library/collections/{collectionId}

Request

  • Base URL
    https://elicit.com/api/v2
  • URL
    https://elicit.com/api/v2/library/collections/{collectionId}
  • Auth
    HTTP bearer

Path parameters

collectionIdstring uuid required

Request body

namestring
descriptionstring

Response

The updated collection.

idstring uuid required
namestring required
descriptionstring required
role'owner' | 'writer' | 'reader' required

Your access level. A reader can view the collection. A writer can also add and remove sources and edit the name and description. An owner can also delete the collection and change who it is shared with.

kind'personal' | 'group' required

personal: never shared; lists your own sources. group: has been shared at least once; owns copies of its sources, and stays a group collection.

sharedVia'direct' | 'organization'

direct if the owner shared the collection with you. organization if the owner shared it with your organization. Absent on your own collections.

sourceCountinteger required

Changes