Draft Registrations

Update a Draft Registration

Updates a Draft Registration by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged. Note this will not register or change the machine state of a Draft Registration, it can only edit the Draft Registration's attributes prior to its registration.

Permissions

Only draft registration contributors may view draft registrations and only draft registration contributors with WRITE or ADMIN permissions may update draft registrations.

Returns

Returns a JSON object with a data key containing the new representation of the updated draft registration, 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.

patch/draft_registrations/{draft_id}/

Request

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

Path parameters

draft_idstring required

The unique identifier of the draft registration.

Request body

object required

Example request

{
  "data": {
    "id": "626ffc1ad90ebe0011fc7601",
    "type": "draft_registrations",
    "attributes": {
      "title": "test title change",
      "registration_responses": {
        "summary": "Test Value"
      }
    }
  }
}

Response

OK

Changes

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