v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB

Registrations

Update a registration

Updates a registration's privacy from private to public.

Registrations can be updated with either a PUT or PATCH request. The public field is the only field that can be modified on a registration

Registrations can only be turned from private to public, not vice versa.

Permissions

Only project administrators may update a registration.

Returns

Returns a JSON object with a data key containing the new representation of the updated 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/registrations/{registration_id}/

Path parameters

registration_idstring required

The unique identifier of the registration.

Request body

idstring required

The unique identifier of the registration.

typestring required

The type identifier of the registration entity (registrations).

Example request

{
  "data": {
    "type": "registrations",
    "attributes": {
      "draft_registration": "{draft_registration_id}",
      "registration_choice": "embargo",
      "lift_embargo": "2017-05-10T20:44:03.185000"
    }
  }
}

Response

Created