API Reference

Update User

put
https://example.com/programs//accounts//users/

Structure of API Call: PUT /programs/{programCode}/accounts/{accountIdentifier}/users/{userIdentifier}

  • Updates Select Properties of a User

This endpoint gives the partner the ability to update an existing user’s information.

Path Params
string
required

Unique account identifier (UID or GUID).

string
required

Unique user identifier (UID or GUID).

string
required

Partner program code for the account.

Body Params

Encrypted request to update user information. See Gd.Bos.DataTransfer.Request.UpdateUserRequestEncrypted for required fields.

encryptedUserData
object

Represents a container for encrypted data used in secure data transfer operations. Contains the encrypted payload and associated cryptographic metadata, including encryption version, ephemeral public key, and public key hash. Used to securely transmit sensitive information such as user data, ensuring confidentiality and integrity during transport.

string | null

The user's preference for accepting peer-to-peer transfers (e.g., "AutoAccept", "ManualAccept").

termsAcceptances
array of objects | null

A list of terms and conditions acceptances, indicating which terms the user has agreed to and the acceptance date/time.

termsAcceptances
contactVerificationIdentifiers
array of uuids | null

A list of contact verification identifiers (GUIDs) used to verify user contact methods (e.g., email, phone).

contactVerificationIdentifiers
string | null

The date and time when the user identifier was created, typically in ISO 8601 format.

string | null

The date and time when the user's password was last changed, typically in ISO 8601 format.

string | null

Indicates whether multi-factor authentication (MFA) should be ignored for this request. Used for specific scenarios.

Headers
string
required

Unique request tracking identifier (X-GD-RequestId header).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

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

Updated 2 months ago