latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

General.User

Update user profile

Updates the modifiable fields of a user's profile. Refer to the body schema to see which fields are modifiable.

put/api/v1/user/profile

Request body

localestring

The configured locale of the user. Defaults to default locale for the user's market. This can be modified by the user.

periodAdjustedDayinteger

The configured day of the month to break the adjusted period on. Defaults to default period adjusted day for the user's market. This can be modified by the user. A valid value should be in the range between 1 and 31. If the adjusted day is after the last day of a given month, then it is treated as the last day of the month.

periodMode'MONTHLY' | 'MONTHLY_ADJUSTED'

The configured monthly period mode of the user. Defaults to default period mode for the user's market. This can be modified by the user.

Example request

{
  "locale": "sv_SE",
  "periodAdjustedDay": 25,
  "periodMode": "MONTHLY_ADJUSTED"
}

Response

The user profile was successfully updated and returned.

currencystring required

The configured ISO 4217 currency code of the user. Defaults to default currency for the user's market.

localestring required

The configured locale of the user. Defaults to default locale for the user's market. This can be modified by the user.

marketstring required

The primary market/country of the user.

periodAdjustedDayinteger required

The configured day of the month to break the adjusted period on. Defaults to default period adjusted day for the user's market. This can be modified by the user. A valid value should be in the range between 1 and 31. If the adjusted day is after the last day of a given month, then it is treated as the last day of the month.

periodMode'MONTHLY' | 'MONTHLY_ADJUSTED' required

The configured monthly period mode of the user. Defaults to default period mode for the user's market. This can be modified by the user.

timeZonestring required

The configured time zone of the user. Defaults to default time zone for the user's market. This can be modified by the user.

Example response

{
  "currency": "SEK",
  "locale": "sv_SE",
  "market": "SE",
  "periodAdjustedDay": 25,
  "periodMode": "MONTHLY_ADJUSTED",
  "timeZone": "Europe/Stockholm"
}