v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Preprints

Create a Contributor

Adds a contributor to a Preprint, effectively creating a relationship between the Preprint and a user.

Contributors are users who can make changes to the Preprint. Contributors with WRITE permissions may edit preprint details, and ADMIN Contributors may add or remove other Contributors.

Contributors are categorized as either "bibliographic" or "non-bibliographic" contributors. From a permissions standpoint, both are the same, but bibliographic contributors are included in citations and are listed on the project overview page on the OSF, while non-bibliographic contributors are not.

Permissions

Only project administrators can add contributors to a Preprint.

Required

A relationship object with a data key, containing the users type and valid user ID is required.

All attributes describing the relationship between the Preprint and the user are optional.

Returns

Returns a JSON object with a data key containing the representation of the new contributor, if the request is successful.

If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes to understand why this request may have failed.

post/preprints/{preprint_id}/contributors/

Path parameters

preprint_idstring required

The unique identifier of the Preprint.

Request body

idstring

The identifier of the contributor entity. Contributor identifiers have the form {preprint_id}-{user_id}.

typestring required

The type identifier of the contributor entity (contributors).

Response

Success