Sign in
latestOpenAPI 3.1.02026-08-2071165551.9 KB

1715bd3719ed

Collections

Update a custom collection (called Dashboards in the UI) by slug

Only DOI collections can be updated via this endpoint. Use /create for search query based collections.

put/api_partner/collections/{collection_slug}

Path parameters

collection_slugstring required

Headers

authorizationstring

Set to Bearer <token> to pass token for authorization.

Set to Bearer <token> to pass token for authorization.

Request body

namestring required
emailstring email required
descriptionstring
isPublicboolean
isSharedWithOrgboolean
doisstring[] required
enableDashboardCitationAlertsboolean

Response

Successful Response

idinteger required
namestring required
descriptionstring
slugstring nullable
dashboardTypestring nullable
isPublicboolean
organizationSlugstring nullable
lastUpdatedstring date nullable
doisUpdatedTSstring date-time nullable
doisRefreshedTSstring date-time nullable
refreshStatusstring
accessTypestring nullable
totalDoiCountinteger
matchedDoiCountinteger
unmatchedDoiCountinteger
warningstring nullable