v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB

Advertisers

Create Advertiser

post/networks/advertisers

Query parameters

notificationboolean

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

Request body

namestring required

The advertiser's display name.

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

Account status.

network_employee_idinteger required

ID of the account manager (network employee) assigned to this advertiser.

default_currency_idstring required

ISO currency code for the advertiser's default currency (e.g. "USD").

sales_manager_idinteger

ID of the sales manager assigned to this advertiser.

internal_notesstring

Private notes visible only to network users.

labelsstring[]

Labels to assign to the advertiser.

verification_tokenstring

Adds an additional layer of security by requiring a unique encrypted ID to be passed in the Advertiser Postback, which can help prevent fraudulent conversions from being fired to Everflow. If the token doesn't match, conversions will be rejected. Supports up to 50 alphanumeric characters.

attribution_method'last_touch' | 'first_touch'

Click attribution method. Determines whether the first or last partner touchpoint receives attribution credit for conversions. Defaults to last_touch.

attribution_priority'click' | 'coupon_code'

Whether clicks or coupon codes take priority for attribution. Defaults to click.

email_attribution_method'last_affiliate_attribution' | 'first_affiliate_attribution'

Email-based attribution method. Defaults to last_affiliate_attribution.

is_contact_address_enabledboolean

Set to true to store a contact address for this advertiser.

platform_namestring

The name of the shopping cart or attribution platform that your advertiser uses (e.g. Shopify, Adjust).

platform_urlstring

URL for logging into your advertiser's platform.

platform_usernamestring

Username details for logging into your advertiser's platform.

reporting_timezone_idinteger required

Timezone ID used for this advertiser's reporting. Can be found using the metadata API.

accounting_contact_emailstring

Email address for accounting/billing contact.

offer_id_macrostring required

Offer ID parameter for Direct Linking. This determines your preferred link format for receiving the Offer ID when using a Direct Linking Setup. Defaults to oid.

affiliate_id_macrostring required

Partner ID parameter for Direct Linking. This determines your preferred link format for receiving the Partner's ID when using a Direct Linking Setup. Defaults to affid.

integrationsobject

Third-party integration settings for this advertiser.

Response

Advertiser created successfully.

network_advertiser_idinteger

Unique advertiser ID.

network_idinteger

Network ID.

namestring

Advertiser name.

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

Current account status.

network_employee_idinteger

Account manager employee ID.

sales_manager_idinteger

Sales manager employee ID.

internal_notesstring

Private notes visible only to network users.

default_currency_idstring

ISO currency code for the advertiser's default currency (e.g. "USD").

platform_namestring

Shopping cart or attribution platform name (e.g. Shopify, Adjust).

platform_urlstring

URL for logging into the advertiser's platform.

platform_usernamestring

Username for the advertiser's platform.

reporting_timezone_idinteger

Timezone ID used for this advertiser's reporting.

attribution_method'first_touch' | 'last_touch'

Click attribution method.

email_attribution_method'last_affiliate_attribution' | 'first_affiliate_attribution'

Email-based attribution method.

attribution_priority'click' | 'coupon_code'

Whether clicks or coupon codes take priority for attribution.

accounting_contact_emailstring

Email address for accounting/billing contact.

verification_tokenstring

Verification token for postback security (max 50 alphanumeric characters).

offer_id_macrostring

Offer ID parameter name for Direct Linking.

affiliate_id_macrostring

Partner ID parameter name for Direct Linking.

address_idinteger

Address record ID.

is_contact_address_enabledboolean

Whether a contact address is stored for this advertiser.

is_expose_publisher_reporting_databoolean nullable

Whether publisher reporting data is exposed to this advertiser.

labelsstring[]

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

time_createdinteger

Unix timestamp when the advertiser was created.

time_savedinteger

Unix timestamp when the advertiser was last updated.

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "users": {
      "entries": [
        {
          "time_created": 1734455015,
          "time_saved": 1734455015
        }
      ]
    },
    "api_keys": {
      "entries": [
        {
          "time_created": 1734455015,
          "time_saved": 1734455015
        }
      ]
    },
    "product_feeds": [
      {
        "time_saved": 1734455015,
        "time_created": 1734455015
      }
    ]
  }
}