action figshare_private_article_embargo_update { label: "Update Article Embargo" description: "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." provider: figshare method: PUT path: "/account/articles/{article_id}/embargo" encoding: json input: { type: "object" required: ["embargo_date", "embargo_type", "is_embargoed"] properties: { embargo_date: { type: "string" description: "Date when the embargo expires and the article gets published, '0' value will set up permanent embargo" } embargo_options: { type: "array" description: "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." items: { type: "object" } } embargo_reason: { type: "string" description: "Reason for setting embargo" } embargo_title: { type: "string" description: "Title for embargo" } embargo_type: { type: "string" description: "Embargo can be enabled at the article or the file level. Possible values: article, file" enum: ["article", "file"] } is_embargoed: { type: "boolean" description: "Embargo status" } } } output: { type: "object" additionalProperties: true } }