Update Recipient Nickname and Status

put

https://example.com/programs/{programCode}/directory/updateRecipient

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

Path Params

programCode

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.

consumerProfileDirectoryKey

int64

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

recipientStatus

string | null

The status of the recipient.

nickName

string | null

The nickname assigned to the recipient.

resourceId

string | null

The unique resource identifier associated with the recipient.

programCode

string | null

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

Headers

X-GD-RequestId

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:

Responses

401

Unauthorized

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

text/json

200OK

403Forbidden

500Internal Server Error

503Service Unavailable