latestOpenAPI 3.0.42026-08-10174362.4 KB

70fb92d278f5

References

Create Citations

Creates one or more manual reference citations inside existing folders.

Required fields: folderId, title.

Optional fields: publicationName, publicationDate, author, notes, abstract, doi, pmid, standardNumber1, standardNumber2, pages, issue, volume, subFolderId, tagsId.

Supports both numeric and GUID folder IDs. A failure on one citation does not affect others in the same request.

All responses use HTTP 200. Check each item's success field. When success is false, the error field contains a description and citationId is null.

post/references/folder/citations

Request body

folderIdstring nullable

The folder in which to create the citation. Accepts numeric identifiers and GUID-format strings.

titlestring nullable

The citation title. Required.

publicationNamestring nullable

The publication or journal name. Optional.

publicationDatestring nullable

The publication date. Optional. Accepted formats: yyyy, yyyy-MM, yyyy-MM-dd.

authorstring nullable

The author or authors. Optional. Accepts a comma-separated string.

notesstring nullable

Free-text notes. Optional.

abstractstring nullable

The citation abstract. Optional.

doistring nullable

Digital Object Identifier. Optional.

pmidstring nullable

PubMed ID. Optional.

standardNumber1string nullable

Primary standard number (e.g., ISSN). Optional.

standardNumber2string nullable

Secondary standard number. Optional.

pagesstring nullable

Page range. Optional.

issuestring nullable

Issue number. Optional.

volumestring nullable

Volume number. Optional.

subFolderIdstring nullable

Sub-folder identifier. Optional. Accepts a comma-separated list of identifiers.

tagsIdstring[] nullable

The identifiers of the tags to associate with the citation. Duplicate values are ignored. This field is optional.

Response

Citations processed.

folderIdstring nullable

Echo of the folder identifier from the request.

citationIdstring nullable

The generated citation identifier (numeric or 32-character hex GUID). Null when Success is false.

successboolean

Indicates whether the citation was created successfully.

errorstring nullable

Error description when Success is false. Null when the operation succeeds.