Update Affiliate

PUT /networks/affiliates/{affiliateId}

Update Affiliate

cURL

curl --request PUT \
  --url https://api.eflow.team/v1/networks/affiliates/{affiliateId} \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "name": "Updated Affiliate Name",
  "account_status": "active",
  "network_employee_id": 2,
  "default_currency_id": "USD",
  "internal_notes": "Updated notes",
  "enable_media_cost_tracking_links": true,
  "is_contact_address_enabled": true,
  "network_affiliate_tier_id": 1,
  "contact_address": {
    "address_1": "456 Oak Ave",
    "address_2": "Floor 3",
    "city": "San Francisco",
    "region_code": "CA",
    "country_code": "US",
    "zip_postal_code": "94102"
  },
  "labels": [
    "premium",
    "media-buyer"
  ],
  "billing": {
    "billing_frequency": "monthly",
    "payment_type": "none",
    "details": {
      "day_of_month": 1
    },
    "billing": {}
  }
}
'

200

{
  "network_affiliate_id": 123,
  "network_id": 123,
  "name": "<string>",
  "account_status": "active",
  "network_employee_id": 123,
  "internal_notes": "<string>",
  "default_currency_id": "<string>",
  "enable_media_cost_tracking_links": true,
  "is_contact_address_enabled": true,
  "has_notifications": true,
  "network_traffic_source_id": 123,
  "account_executive_id": 123,
  "adress_id": 123,
  "address_id": 123,
  "referrer_id": 123,
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "labels": {
      "total": 123,
      "entries": [
        "<string>"
      ]
    },
    "account_manager": {
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "work_phone": "<string>",
      "cell_phone": "<string>",
      "instant_messaging_id": 123,
      "instant_messaging_identifier": "<string>"
    },
    "encoded_value": "<string>",
    "ios_app_sources": {
      "total": 123,
      "entries": [
        {}
      ]
    },
    "users": {
      "total": 123,
      "entries": [
        {}
      ]
    }
  }
}

Update an existing affiliate. Any omitted non-required fields will be reset to their defaults. Use the Bulk Edit endpoint if you only need to change specific fields. Note: you cannot add or update users when updating an affiliate. Use the Affiliate User endpoints instead.

Authorizations

X-Eflow-Api-Key · string · header · required

The Everflow API key generated from the Control Center > Security.

Path Parameters

affiliateId · integer · required

The unique affiliate ID to update.

Body

application/json

name · string · required

The name of the affiliate.

account_status · enum<string> · required

The affiliate's account status.

Available options: active, inactive

network_employee_id · integer · required

The employee ID of the affiliate's account manager.

default_currency_id · string · required

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

billing · object · required

The affiliate's billing information.

Show child attributes

internal_notes · string

Internal notes for network usage.

enable_media_cost_tracking_links · boolean

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

referrer_id · integer

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

is_contact_address_enabled · boolean

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

network_affiliate_tier_id · integer

The ID of the Affiliate Tier.

contact_address · object

The affiliate's contact address information. Only required if is_contact_address_enabled is set to true.

Show child attributes

labels · string[]

Used to associate labels to the affiliate.

A label string.

Response

200

application/json

Affiliate updated successfully.

An affiliate (partner) account in the network.

network_affiliate_id · integer

Unique affiliate ID.

network_id · integer

Network ID.

name · string

Affiliate name.

account_status · enum<string>

Current account status.

Available options: active, inactive, pending, suspended

network_employee_id · integer

Account manager employee ID.

internal_notes · string

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

default_currency_id · string

Default currency code (e.g. USD).

enable_media_cost_tracking_links · boolean

Whether media cost tracking links are enabled for this affiliate.

is_contact_address_enabled · boolean

Whether the contact address is enabled.

has_notifications · boolean

Whether notifications are enabled.

network_traffic_source_id · integer

Associated traffic source ID.

account_executive_id · integer

Account executive employee ID.

adress_id · integer

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

address_id · integer

Address record ID (alias).

referrer_id · integer

ID of the referring affiliate, if any.

time_created · integer

Unix timestamp when the affiliate was created.

Example:

1734455015

time_saved · integer

Unix timestamp when the affiliate was last updated.

Example:

1734455015

relationship · object

Related data (only present when requested via query parameter).

Show child attributes