Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Advertiser Users

Create Advertiser User

post/networks/advertisers/{advertiserId}/users

Path parameters

advertiserIdinteger required

The ID of the advertiser for whom to create a user.

Query parameters

notificationboolean

Whether to send a welcome notification email to the user. Defaults to true when omitted.

Request body

first_namestring required

The advertiser user's first name.

last_namestring required

The advertiser user's last name.

emailstring required

The advertiser user's email. Must be unique among all advertiser users. Used to log in the platform.

titlestring

The advertiser user's title.

work_phonestring

The advertiser user's work phone number.

cell_phonestring

The advertiser user's cell phone number.

instant_messaging_idinteger

The ID of an instant messaging platform. Values are 0 for None, 1 for Skype, 2 for Yahoo Messenger, 3 for Telegram, 4 for WhatsApp, 5 for Other.

instant_messaging_identifierstring

The advertiser user's instant messaging identifier. Required when an instant_messaging_id is selected.

language_idinteger required

The advertiser user's language ID. This is limited to the value 1 (English).

timezone_idinteger required

The advertiser user's timezone ID. Can be found using the metadata API.

currency_idstring required

The advertiser user's currency ID. Can be found using the metadata API.

account_status'active' | 'inactive' | 'suspended' required

The advertiser user's account status.

send_activation_emailboolean

When set to true, an activation email is sent to the user notifying them of their account creation.

set_password_manuallyboolean

When set to true, the initial_password field is required and will be used as the user's login password. When false, the user will receive a password reset email to set their own password.

initial_passwordstring

The user's login password. Required when set_password_manually is true. Must be a minimum of 12 characters.

Response

network_advertiser_user_idinteger

Unique advertiser user ID.

network_idinteger

The network ID this user belongs to.

network_advertiser_idinteger

The advertiser ID this user belongs to.

first_namestring

The advertiser user's first name.

last_namestring

The advertiser user's last name.

emailstring

The advertiser user's email address.

titlestring

The advertiser user's title.

account_status'active' | 'inactive' | 'suspended'

The advertiser user's account status.

work_phonestring

The advertiser user's work phone number.

cell_phonestring

The advertiser user's cell phone number.

instant_messaging_idinteger

The ID of an instant messaging platform. Values are 0 for None, 1 for Skype, 2 for Yahoo Messenger, 3 for Telegram, 4 for WhatsApp, 5 for Other.

instant_messaging_identifierstring

The advertiser user's instant messaging identifier.

language_idinteger

The advertiser user's language ID.

timezone_idinteger

The advertiser user's timezone ID.

currency_idstring

The advertiser user's currency ID (ISO currency code).

time_createdinteger

Unix timestamp of creation.

time_savedinteger

Unix timestamp of last update.

Example response

{
  "relationship": {
    "customization": {
      "time_created": 1734455015,
      "time_saved": 1734455015
    }
  },
  "time_created": 1734455015,
  "time_saved": 1734455015
}