---
title: "Update a registration"
method: PATCH
path: "/registrations/{registration_id}/"
tags: ["Registrations"]
---

# Update a registration

`PATCH /registrations/{registration_id}/`

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](#tag/Errors-and-Error-Codes) to understand why this request may have failed.

## Path parameters

- `registration_id` string, required

## Request body

- object
  - `id` string, required — The unique identifier of the registration.
  - `type` string, required — The type identifier of the registration entity (`registrations`).
  - `attributes` object, required — The properties of the registration entity.
    - `category` 'analysis' | 'communication' | 'data' | 'hypothesis' | 'instrumentation' | 'methods and measures' | 'procedure' | 'project' | 'software' | 'other' — The category of the registered node.
    - `collection` boolean — Whether or not this registration represents a collection. This value should always be `false`. This field may be deprecated in future versions.
    - `current_user_can_comment` boolean — Whether or not the current user has permission to post comments on this registration. Comments on registrations can be set to allow all users to comment or restricted to only contributors.
    - `current_user_permissions` string[] — A list of strings representing the permissions for the current user on this registration. Valid permissions are "admin", "read", and "write".
    - `date_created` string, date-time — The time at which the registered node was created, as an iso8601 formatted timestamp.
    - `date_modified` string, date-time — The time at which the registered node was last modified, as an iso8601 formatted timestamp.
    - `date_registered` string, date-time — The time at which this registration was created, as an iso8601 formatted timestamp.
    - `date_withdrawn` string, date-time — The time at which this registration was withdrawn, as an iso8601 formatted timestamp.
    - `description` string — The description of the registered node.
    - `embargo_end_date` string, date-time — The time at which the embargo on this registration will be lifted and the registration will become public, as an iso8601 formatted timestamp.
    - `fork` boolean — Whether or not this registration represents a fork of another node.
    - `node_license` string — A dictionary containing the metadata (copyright year and holder) associated with the registered node license (required for certain license types).
    - `pending_embargo_approval` boolean — Whether or not the embargo associated with this registration is pending approval from project administrators.
    - `pending_registration_approval` boolean — Whether or not the registration is pending approval from project administrators.
    - `pending_withdrawal` boolean — Whether or not the registration is pending approval for withdrawal from project administrators.
    - `preprint` boolean — Whether or not a preprint has been created from this node, or if this node was created for a preprint.
    - `public` boolean — Whether or not the registration is publicly visible.
    - `registration` boolean — Whether or not this is a registration. This value should always be `true`. This field may be deprecated in future versions.
    - `registered_meta` string — A dictionary with supplemental registration questions and responses.
    - `registration_supplement` string — The title of the registration schema this registration conforms to.
    - `tags` string[] — A list of strings that describe the registered node.
    - `template_from` string — The unique ID of the node from which the registered node was templated, if the registered node was created from a template.
    - `title` string — The title of the registered node.
    - `withdrawn` boolean — Whether or not this registration has been withdrawn.
    - `withdrawal_justification` string — The reasoning for why this registration was withdrawn, as entered by the administrator that initiated the withdrawal.
  - `relationships` object, required — URLs to other entities or entity collections that have a relationship to the registration entity.
    - `affiliated_institutions` string — A link to the list of institutions this registration is affiliated with.
    - `children` string — A link to the list of the registered node's children (components).
    - `citation` string — A link to the citation details of this registration.
    - `comments` string — A link to the list of comments on this registration.
    - `contributors` string — A link to the list of contributors on this registration.
    - `files` string — A link to the list of storage providers that have been enabled on this registration.
    - `forks` string — A link to the list of nodes that are forks of this registration.
    - `identifiers` string — A link to the list of identifiers for this registration (i.e. ARK and DOI identifiers).
    - `logs` string — A link to the list of log actions pertaining to this registration.
    - `linked_nodes` string — A link to the list of nodes that are linked to this registration.
    - `node_links` string — A link to the list of nodes that are linked to this registration. This field is deprecated as of verson 2.1; use the linked_nodes link instead.
    - `parent` string — A link to the node that is the direct parent of the current registration, if the current registration is a child registration.
    - `registered_by` string — A link to the user that initiated this registration.
    - `registered_from` string — A link to the node that this registration was registered from.
    - `registration_schema` string — A link to the metaschema that this registration conforms to.
    - `root` string — A link to the node that is the top-level parent of the current registration. If the current registration is the top-level node, the root is the current registration.
    - `view_only_links` string — A link to the list of view only links that have been created for this registration.
    - `wikis` string — A link to the list of wiki pages for this registration.
  - `links` object, required — URLs to alternative representations of the registrations entity.
    - `html` string, URL — A link to the registration's page on the OSF.
    - `self` string, URL — A link to the canonical API endpoint of this registration.

## Response `200`

Created

---

[API](https://skmtc.net/osf/apis/osf-apiv2-documentation.md) · [All operations](https://skmtc.net/osf/apis/osf-apiv2-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/osf/osf-apiv2-documentation/versions/ca701048eb0d/schema)