collections

Create collection private link

Create new private link

post/account/collections/{collection_id}/private_links

Request

Base URL
https://api.figshare.com/v2
Auth
OAuth 2
Authorization codehttps://figshare.com/account/applications/authorize
Token URLhttps://api.figshare.com/v2/token
Scopesall
TypeScript
https://skmtc.dev/figshare/apis/figshare-api/docs/account/collections/:collection_id/private_links/post.ts
A function with typed inputs. Its response is checked against the schema.

collection_idinteger required

Collection unique identifier

expires_datestring

Date when this private link should expire - optional. By default private links expire in 365 days.

{
  "expires_date": "2018-02-22 22:22:22"
}

Created

locationstring url required

Url for private link

html_locationstring url required

HTML url for private link

tokenstring required

Token for private link

{
  "html_location": "https://figshare.com/s/d5ec7a85bcd6dbe9d9b2",
  "token": "d5ec7a85bcd6dbe9d9b2"
}