Update Recipient Nickname and Status

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

Path Params
string
required

The program code identifying the BaaS program context.

Body Params

The request payload containing recipient update details.

  • ConsumerProfileDirectoryKey: The directory key for the recipient.

  • RecipientStatus: The status of the recipient.

  • NickName: The nickname for the recipient.

  • ResourceId: The resource identifier.

  • ProgramCode: The program code.

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.

int64

The unique directory key for the consumer profile associated with the recipient.

string | null

The status of the recipient.

string | null

The nickname assigned to the recipient.

string | null

The unique resource identifier associated with the recipient.

string | null

The program code associated with the request, used for routing and business context.

Headers
string
required

A unique request identifier for tracking and logging. Should be a GUID.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

401

Unauthorized

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json