---
title: "PATCH /recipients/{name}"
method: PATCH
path: "/recipients/{name}"
tags: ["RecipientsService"]
---

# PATCH /recipients/{name}

`PATCH /recipients/{name}`

Update a recipient.

## Path parameters

- `name` string, required

## Request body

- UpdateRecipientRequest — Update a recipient
  - `name` string, required — Name of the recipient.
  - `newName` string — New name for the recipient
  - `owner` string — Username of the recipient owner.
  - `comment` string — Description about the recipient.
  - `properties` object — Recipient properties as map of string key-value pairs. When provided in update request, the specified properties will override the existing properties. To add and remove properties, one would need to perform a read-modify-write.
  - `expirationTime` string — Expiration timestamp of the token, in epoch milliseconds.

## Response `200`

OK

- RecipientInfo
  - `id` string — Unique ID of the recipient.
  - `name` string — The name of the recipient.
  - `authenticationType` integer — The delta sharing authentication type.
  - `owner` string — Username of the recipient owner.
  - `comment` string — Description about the recipient.
  - `properties` object — A map of key-value properties attached to the securable.
  - `createdAt` string — Time at which this share was created, in epoch milliseconds.
  - `createdBy` string — Username of the creator of the share.
  - `tokens` RecipientToken[] — This field is only present when the authentication_type is TOKEN.
    - `id` string — Unique ID of the recipient token.
    - `createdAt` string — Time at which this recipient token was created, in epoch milliseconds.
    - `createdBy` string — Username of recipient token creator.
    - `activationUrl` string — Full activation URL to retrieve the access token. It will be empty if the token is already retrieved.
    - `expirationTime` string — Expiration timestamp of the token in epoch milliseconds.
    - `updatedAt` string — Time at which this recipient token was updated, in epoch milliseconds.
    - `updatedBy` string — Username of recipient token updater.
  - `updatedAt` string — Time at which this share was updated, in epoch milliseconds.
  - `updatedBy` string — Username of share updater.

## Other responses

- `default` — Default error response

---

[API](https://skmtc.net/delta-incubator/apis/delta-sharing-api.md) · [All operations](https://skmtc.net/delta-incubator/apis/delta-sharing-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/delta-incubator/delta-sharing-api/versions/a47a0389fffc/schema)