API Reference

Update User – Updates an existing user profile.

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

Updates the user profile for the specified user identifier. Only the fields provided in the request will be updated. Returns the updated user details or validation errors.

Path Params
string
required

The unique identifier of the user to update. Must be a valid GUID.

string
required

The program code associated with the partner implementation. This identifies the specific program context for the user update.

Body Params

The Gd.Bos.DataTransfer.Request.UpdateUserRequest object containing updated user profile information. Only the fields to be updated need to be provided.

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

The unique request identifier for idempotency and tracking. Must be provided in the 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