FIfigshare
articles

Update Article Embargo

Changed on

Note: setting an article under whole embargo does not imply that the article will be published when the embargo will expire. You must explicitly call the publish endpoint to enable this functionality.

put/account/articles/{article_id}/embargo

Request

Path parameters

article_idinteger required

Article unique identifier

Request body

is_embargoedboolean required

Embargo status

embargo_datestring required

Date when the embargo expires and the article gets published, '0' value will set up permanent embargo

embargo_type'article' | 'file' required

Embargo can be enabled at the article or the file level. Possible values: article, file

embargo_titlestring

Title for embargo

embargo_reasonstring

Reason for setting embargo

embargo_optionsobject[]

List of embargo permissions to be associated with the article. The list must contain id and can also contain group_ids(a field that only applies to 'logged_in' permissions). The new list replaces old options in the database, and an empty list removes all permissions for this article. Administration permission has to be set up alone but logged in and IP range permissions can be set up together.

Example request

{
  "is_embargoed": true,
  "embargo_date": "2018-05-22T04:04:04",
  "embargo_type": "file",
  "embargo_title": "File(s) under embargo",
  "embargo_options": [
    {
      "id": 1321
    },
    {
      "id": 3345
    },
    {
      "id": 54621,
      "group_ids": [
        4332,
        5433,
        678
      ]
    }
  ]
}

Response

Reset Content

Changes

  • 5806e3dd43b2Revision changes
    • breaking

      added the new path request parameter article_id

    • breaking

      added required request body

    • info

      added the media type application/json for the response with the status