Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Affiliate Users

Create Affiliate User

post/networks/affiliates/{affiliateId}/users

Path parameters

affiliateIdinteger required

The ID of the affiliate 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 affiliate user's first name.

last_namestring required

The affiliate user's last name.

emailstring required

The affiliate user's email. Must be unique among all affiliate users. Is used to log in the platform.

language_idinteger required

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

timezone_idinteger required

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

titlestring

The affiliate user's title.

work_phonestring

The affiliate user's work phone number.

cell_phonestring

The affiliate user's cell phone number.

instant_messaging_idinteger

The ID of an instant messaging platform. Allows you to save their identifier for further reference. 0 = None, 1 = Skype, 2 = Yahoo Messenger, 3 = Telegram, 4 = WhatsApp, 5 = Other.

instant_messaging_identifierstring

The affiliate user's instant messaging identifier, if instant_messaging_id was different than 0.

currency_idstring required

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

account_status'active' | 'inactive' required

The affiliate user's account status. Can be either active or inactive.

initial_passwordstring

The affiliate user's login password. If left empty, the affiliate will be sent an email asking to set their password. If supplied, the password must have a length of at least 12 characters.

Response

network_affiliate_user_idinteger

Unique affiliate user ID.

network_idinteger

The network ID this user belongs to.

network_affiliate_idinteger

The affiliate ID this user belongs to.

first_namestring

The affiliate user's first name.

last_namestring

The affiliate user's last name.

emailstring

The affiliate user's email address. Is used to log in the platform.

titlestring

The affiliate user's title.

work_phonestring

The affiliate user's work phone number.

cell_phonestring

The affiliate user's cell phone number.

instant_messaging_idinteger

The ID of an instant messaging platform.

instant_messaging_identifierstring

The affiliate user's instant messaging identifier.

language_idinteger

The affiliate user's language ID.

timezone_idinteger

The affiliate user's timezone ID.

currency_idstring

The affiliate user's currency ID.

account_status'active' | 'inactive'

The affiliate user's account status. Can be either active or inactive.

time_createdinteger

Unix timestamp of when the user was created.

time_savedinteger

Unix timestamp of when the user was last updated.

Example response

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