Resources

Update a resource

Update one or more metadata fields of a specific resource.

Only the fields provided in the request payload will be updated.

patch/resources/{resource_id}/

Request

  • Base URL
    https://api.test.osf.io/v2
  • URL
    https://api.test.osf.io/v2/resources/{resource_id}/
  • Auth
    none declared

Path parameters

resource_idstring required

The unique identifier of the resource to update.

Request body

Example request

{
  "data": {
    "id": "abc123",
    "type": "resources",
    "attributes": {
      "description": "Updated dataset description.",
      "resource_type": "materials",
      "finalized": true,
      "pid": "10.5678/resource.9012"
    }
  }
}

Response

Resource updated successfully.

Changes

No recorded changes to this operation across all 2 revisions of this API.