Skip to main content
PATCH
Update user data

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Represents an update command for a user.

budget
number
required

The total budget currently available to the user.

campaign_count
integer
required

The number of campaigns owned by the user.

Required range: x >= 0
creative_count
integer
required

The number of creatives owned by the user.

Required range: x >= 0
credit
number
required

The total credit currently available to the user.

id
string<uuid>
required

The ID of the user.

name
string
required

The name of the user.

Required string length: 4 - 32
permissions
Permissions · object
required

The permissions information of the user.

Examples:
placement_count
integer
required

The number of placements owned by the user.

Required range: x >= 0
preferences
UserPreferences · object | null
required

Represents a user preferences.

email
string<email> | null

The email of the user.

is_active
boolean | null

Is the user active.

is_superuser
boolean | null

Is the user admin.

is_verified
boolean | null

Is the user email is verified.

password
string | null

The password of the user.

Response

Successful Response

Represents a read command for a user.

budget
number
required

The total budget currently available to the user.

campaign_count
integer
required

The number of campaigns owned by the user.

Required range: x >= 0
creative_count
integer
required

The number of creatives owned by the user.

Required range: x >= 0
credit
number
required

The total credit currently available to the user.

email
string<email>
required

The email of the user.

id
string<uuid>
required

The id of the user.

is_active
boolean
required

Is the user active.

is_superuser
boolean
required

Is the user admin.

is_verified
boolean
required

Is the user email is verified.

permissions
Permissions · object
required

The permissions information of the user.

Examples:
placement_count
integer
required

The number of placements owned by the user.

Required range: x >= 0
preferences
UserPreferences · object | null
required

Represents a user preferences.

role
enum<string>
required

User role enum.

Available options:
advertiser,
retailer,
admin
name
string | null

The name of the user.