projects

Invite project collaborators

Invite users to collaborate on project or view the project

post/account/projects/{project_id}/collaborators

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/projects/:project_id/collaborators/post.ts
A function with typed inputs. Its response is checked against the schema.

project_idinteger required

Project unique identifier

role_name'viewer' | 'collaborator' required

Role of the the collaborator inside the project

user_idinteger

User id of the collaborator

emailstring

Collaborator email

commentstring

Text sent when inviting the user to the project

{
  "role_name": "viewer",
  "user_id": 100008,
  "email": "user@domain.com",
  "comment": "hey"
}

Created

messagestring required

Response message text

{
  "message": "Project 1 has been published"
}