Sign in
latestOpenAPI 3.0.32026-07-2226694862.5 KB

39242cee0e32

Affiliates

Create Affiliate

post/networks/affiliates

Query parameters

notificationboolean

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

Request body

namestring required

The name of the affiliate.

account_status'active' | 'inactive' required

The affiliate's account status.

network_employee_idinteger required

The employee ID of the affiliate's account manager.

internal_notesstring

Internal notes for network usage.

default_currency_idstring required

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

enable_media_cost_tracking_linksboolean

Whether or not you want to allow the affiliate to pass and override cost in their tracking links. Defaults to false.

referrer_idinteger

The ID of the affiliate that referred the new affiliate. Defaults to 0 (none).

is_contact_address_enabledboolean

Whether or not you want to include a contact address for this affiliate. Defaults to false.

network_affiliate_tier_idinteger

The ID of the Affiliate Tier.

labelsstring[]

Used to associate labels to the affiliate.

Response

Affiliate created successfully.

network_affiliate_idinteger

Unique affiliate ID.

network_idinteger

Network ID.

namestring

Affiliate name.

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

Current account status.

network_employee_idinteger

Account manager employee ID.

internal_notesstring

Internal notes about this affiliate (not visible to the affiliate).

default_currency_idstring

Default currency code (e.g. USD).

enable_media_cost_tracking_linksboolean

Whether media cost tracking links are enabled for this affiliate.

is_contact_address_enabledboolean

Whether the contact address is enabled.

network_affiliate_tier_idinteger

The affiliate tier ID this affiliate belongs to. Only used in create/update requests.

has_notificationsboolean

Whether notifications are enabled.

network_traffic_source_idinteger

Associated traffic source ID.

account_executive_idinteger

Account executive employee ID.

adress_idinteger

Address record ID. Note the field name uses a single 'd' (adress_id) in the API response.

address_idinteger

Address record ID (alias).

referrer_idinteger

ID of the referring affiliate, if any.

labelsstring[]

Labels to assign. Only used in create/update requests. Use the relationship object to read labels.

time_createdinteger

Unix timestamp when the affiliate was created.

time_savedinteger

Unix timestamp when the affiliate was last updated.

Example response

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