Client profiles
Use these methods to obtain and edit client profile data.
GET[host]/api/v2/my/profile |
|
PUT[host]/api/v2/my/profile PATCH[host]/api/v2/my/profile |
Get client profile data
Use this method to get client profile data.
Request
Header parameters:
Authorization: Bearer <access_token>
GET[host]/api/v2/my/profile
curl --location --request GET 'https://host.name/api/v2/my/profile' \
--header 'Authorization: Bearer <token>'
Response
A response contains a Client Profile object providing client-related data.
Update client profile data
Use this method to update a client profile.
Request
Header parameters:
Authorization: Bearer <access_token>
Body:
The following field values can be updated for a client profile:
- nickname string
The client’s nickname used in the B2Core UI.
- locale string
The localization settings applied to the B2Core UI.
- info object
The client personal data.
Show object fields- firstName string
The client’s first name.
- lastName string
The client’s last name.
- middleName string
The client’s middle name.
- birthday string
The client’s date of birth.
PUT[host]/api/v2/my/profile
curl --location --request PUT 'https://host.name/api/v2/my/profile' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"nickname": "Nickname",
"locale": "en_US",
"info": {
"firstName": "James",
"lastName": "Parker",
"middleName": "William",
"birthday": "2022-01-01T00:00:00+00:00"
}
}'
Response
A response includes a Client Profile object providing information about the updated client profile.