Skip to main content
POST
Create a collection from a list of DOIs or a search query

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string

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

Body

application/json
name
string
required
email
string<email>
required
description
string | null
default:""
isPublic
boolean
default:false
isHidden
boolean
default:false
isSharedWithOrg
boolean
default:false
dois
string[] | null
query
QuerySchemaV2 · object | null
enableDashboardCitationAlerts
boolean
default:false

Response

Successful Response

id
integer
required
name
string
required
componentLayout
DashboardComponentLayoutSchema · object[]
required
doiQuery
DashboardDoiQuerySchema · object
required
description
string
default:""
slug
string | null
dashboardType
string | null
isPublic
boolean
default:false
organizationSlug
string | null
lastUpdated
string<date> | null
doisUpdatedTS
string<date-time> | null
doisRefreshedTS
string<date-time> | null
refreshStatus
string
default:-
accessType
string | null
default:VIEWER
totalDoiCount
integer
default:0
matchedDoiCount
integer
default:0
unmatchedDoiCount
integer
default:0
unmatchedDois
any[]
warning
string | null