---
title: "Update Recipient Nickname and Status"
method: PUT
path: "/programs/{programCode}/directory/updateRecipient"
tags: ["TokenManagement"]
---

# Update Recipient Nickname and Status

`PUT /programs/{programCode}/directory/updateRecipient`

Updates the nickname and status of a recipient in the P2P directory.

## Path parameters

- `programCode` string, required

## Headers

- `X-GD-RequestId` string, required

## Request body

- UpdateRecipientRequest — Represents a request to update recipient information for a consumer profile. Contains recipient status, nickname, resource and program identifiers, and the directory key. Inherits standard request metadata from Gd.Bos.DataTransfer.Request.RequestBase.
  - `consumerProfileDirectoryKey` integer — The unique directory key for the consumer profile associated with the recipient.
  - `recipientStatus` string, nullable — The status of the recipient.
  - `nickName` string, nullable — The nickname assigned to the recipient.
  - `resourceId` string, nullable — The unique resource identifier associated with the recipient.
  - `programCode` string, nullable — The program code associated with the request, used for routing and business context.

## Response `200`

OK

- UpdateRecipientResponse — Represents the response returned after updating a recipient. Used to indicate the outcome of a recipient update operation. Inherits standard response metadata from Gd.Bos.DataTransfer.Response.ResponseBase.
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/versions/666553766b78/schema)