Delete a user

DELETE

users

Delete a user

curl --request DELETE \
  --url https://your_a2_service/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "budget": 123,
  "campaign_count": 1,
  "creative_count": 1,
  "credit": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "permissions": {},
  "placement_count": 1,
  "preferences": {
    "etc": {},
    "notification_methods": {},
    "notification_methods_data": {},
    "notifications": {}
  },
  "email": "[email protected]",
  "is_active": true,
  "is_superuser": true,
  "is_verified": true,
  "password": "<string>"
}
'

{
  "budget": 123,
  "campaign_count": 1,
  "creative_count": 1,
  "credit": 123,
  "email": "[email protected]",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": true,
  "is_superuser": true,
  "is_verified": true,
  "permissions": {},
  "placement_count": 1,
  "preferences": {
    "etc": {},
    "notification_methods": {},
    "notification_methods_data": {},
    "notifications": {}
  },
  "role": "advertiser",
  "name": "<string>"
}

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.

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.

placement_count

integer

required

The number of placements owned by the user.

Required range: x >= 0

preferences

UserPreferences · object

required

Represents a user preferences.

Show child attributes

preferences.etc

Etc · object

required

Extra user preferences.

preferences.notification_methods

Notification Methods · object

required

Accepted notification methods.

Show child attributes

preferences.notification_methods.{key}

boolean

preferences.notification_methods_data

Notification Methods Data · object

required

Data used for notification methods.

Show child attributes

preferences.notification_methods_data.{key}

string

preferences.notifications

Notifications · object

required

Accepted notification event types.

Show child attributes

preferences.notifications.{key}

boolean

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.

string<email>

required

The email of the user.

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.

placement_count

integer

required

The number of placements owned by the user.

Required range: x >= 0

preferences

UserPreferences · object

required

Represents a user preferences.

Show child attributes

preferences.etc

Etc · object

required

Extra user preferences.

preferences.notification_methods

Notification Methods · object

required

Accepted notification methods.

Show child attributes

preferences.notification_methods.{key}

boolean

preferences.notification_methods_data

Notification Methods Data · object

required

Data used for notification methods.

Show child attributes

preferences.notification_methods_data.{key}

string

preferences.notifications

Notifications · object

required

Accepted notification event types.

Show child attributes

preferences.notifications.{key}

boolean

role

enum<string>

required

User role enum.

Available options:

advertiser,

retailer,

admin

name

string | null

The name of the user.

Get the current userRetrieves the current user's information.

⌘I

Delete a user

curl --request DELETE \
  --url https://your_a2_service/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "budget": 123,
  "campaign_count": 1,
  "creative_count": 1,
  "credit": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "permissions": {},
  "placement_count": 1,
  "preferences": {
    "etc": {},
    "notification_methods": {},
    "notification_methods_data": {},
    "notifications": {}
  },
  "email": "[email protected]",
  "is_active": true,
  "is_superuser": true,
  "is_verified": true,
  "password": "<string>"
}
'

{
  "budget": 123,
  "campaign_count": 1,
  "creative_count": 1,
  "credit": 123,
  "email": "[email protected]",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_active": true,
  "is_superuser": true,
  "is_verified": true,
  "permissions": {},
  "placement_count": 1,
  "preferences": {
    "etc": {},
    "notification_methods": {},
    "notification_methods_data": {},
    "notifications": {}
  },
  "role": "advertiser",
  "name": "<string>"
}

Data Management APIs

Decision APIs

Authorizations

Body

Response