Custom Creatives

Operations for custom creatives

Find All

GET /v1/networks/custom/creative

Filters

This endpoint supports basic filtering. Refer to API filters page for usage.

Value Description
custom_setting_status Filter based on the custom setting status
time_created Filter based on the creation time
time_saved Filter based on the last update time

cURL
curl --request GET \
  --url 'https://api.eflow.team/v1/networks/custom/creative' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json'
Response
 {
  "custom_creative_settings": [
    {
      "network_custom_creative_setting_id": 0,
      "network_id": 0,
      "network_offer_creative_ids": [
        0
      ],
      "network_affiliate_ids": [
        0
      ],
      "name": "",
      "custom_setting_status": "active",
      "time_created": 0,
      "time_saved": 0,
      "relationship": {
        "affiliates": [
          {
            "network_affiliate_id": 0,
            "network_id": 0,
            "name": "",
            "account_status": "active",
            "network_employee_id": 0,
            "internal_notes": "",
            "has_notifications": true,
            "network_traffic_source_id": 0,
            "account_executive_id": 0,
            "adress_id": 0,
            "default_currency_id": "",
            "is_contact_address_enabled": true,
            "enable_media_cost_tracking_links": true,
            "time_created": 0,
            "time_saved": 0,
            "referrer_id": 0
          }
        ],
        "creative": {
          "network_offer_creative_id": 0,
          "network_id": 0,
          "network_offer_id": 0,
          "name": "",
          "creative_type": "image",
          "is_private": true,
          "creative_status": "active",
          "resource_url": "",
          "html_code": "",
          "width": 0,
          "height": 0,
          "email_from": "",
          "email_subject": "",
          "time_created": 0,
          "time_saved": 0,
          "additional_offer_ids": [
            0
          ],
          "is_apply_specific_affiliates": true
        }
      }
    }
  ]
}

Find By ID

GET /v1/networks/custom/creative/:settingId

Path Parameters

Parameter Description
settingId The ID of a network custom setting

cURL
curl --request GET --url 'https://api.eflow.team/v1/networks/custom/creative/<INSERT SETTING ID>' \
--header 'x-eflow-api-key: <INSERT API KEY>' \
--header 'content-type: application/json'
Response
 {
  "network_custom_creative_setting_id": 0,
  "network_id": 0,
  "network_offer_creative_ids": [
    0
  ],
  "network_affiliate_ids": [
    0
  ],
  "name": "",
  "custom_setting_status": "active",
  "time_created": 0,
  "time_saved": 0,
  "relationship": {
    "affiliates": [
      {
        "network_affiliate_id": 0,
        "network_id": 0,
        "name": "",
        "account_status": "active",
        "network_employee_id": 0,
        "internal_notes": "",
        "has_notifications": true,
        "network_traffic_source_id": 0,
        "account_executive_id": 0,
        "adress_id": 0,
        "default_currency_id": "",
        "is_contact_address_enabled": true,
        "enable_media_cost_tracking_links": true,
        "time_created": 0,
        "time_saved": 0,
        "referrer_id": 0
      }
    ],
    "creative": {
      "network_offer_creative_id": 0,
      "network_id": 0,
      "network_offer_id": 0,
      "name": "",
      "creative_type": "image",
      "is_private": true,
      "creative_status": "active",
      "resource_url": "",
      "html_code": "",
      "width": 0,
      "height": 0,
      "email_from": "",
      "email_subject": "",
      "time_created": 0,
      "time_saved": 0,
      "additional_offer_ids": [
        0
      ],
      "is_apply_specific_affiliates": true
    }
  }
}

Create

POST /v1/networks/custom/creative

network_offer_creative_ids array[int]
network_affiliate_ids array[int]

The offer id.

custom_setting_status string

The custom setting status. Can be either active or inactive

name string

The custom cap setting name.

creative object
network_offer_id int

Only required when you create a new creative on its own (not part of an offer creation).

name string
creative_type string

Allowed values: image, html, thumbnail, email, archive, video, text.

is_private boolean
creative_status string

Allowed values: active, deleted.

html_code string

Only required when creative_type is ‘html’ or ‘email’.

width int

Only required when creative_type is ‘html’.

height int

Only required when creative_type is ‘html’.

email_from string

Only required when creative_type is ‘email’.

email_subject string

Only required when creative_type is ‘email’.

additional_offer_ids array[int]
is_apply_specific_affiliates boolean
resource_file object
temp_url string
original_file_name string
html_files array[object]
temp_url string
original_file_name string
html_assets array[object]
content_type string
filename string
url string
file_size int
image_width int
image_height int 

{
  "network_offer_creative_ids": [
    0
  ],
  "network_affiliate_ids": [
    0
  ],
  "name": "",
  "custom_setting_status": "active",
  "creative": {
    "network_offer_id": 0,
    "name": "",
    "creative_type": "image",
    "is_private": true,
    "creative_status": "active",
    "html_code": "",
    "width": 0,
    "height": 0,
    "email_from": "",
    "email_subject": "",
    "additional_offer_ids": [
      0
    ],
    "is_apply_specific_affiliates": true,
    "resource_file": {
      "temp_url": "",
      "original_file_name": ""
    },
    "html_files": [
      {
        "temp_url": "",
        "original_file_name": ""
      }
    ],
    "html_assets": [
      {
        "content_type": "",
        "filename": "",
        "url": "",
        "file_size": 0,
        "image_width": 0,
        "image_height": 0
      }
    ]
  }
}

cURL
curl --request POST \
  --url 'https://api.eflow.team/v1/networks/custom/creative' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'
Response
{
  "network_custom_creative_setting_id": 0,
  "network_id": 0,
  "network_offer_creative_ids": [
    0
  ],
  "network_affiliate_ids": [
    0
  ],
  "name": "",
  "custom_setting_status": "active",
  "time_created": 0,
  "time_saved": 0,
  "relationship": {
    "affiliates": [
      {
        "network_affiliate_id": 0,
        "network_id": 0,
        "name": "",
        "account_status": "active",
        "network_employee_id": 0,
        "internal_notes": "",
        "has_notifications": true,
        "network_traffic_source_id": 0,
        "account_executive_id": 0,
        "adress_id": 0,
        "default_currency_id": "",
        "is_contact_address_enabled": true,
        "enable_media_cost_tracking_links": true,
        "time_created": 0,
        "time_saved": 0,
        "referrer_id": 0
      }
    ],
    "creative": {
      "network_offer_creative_id": 0,
      "network_id": 0,
      "network_offer_id": 0,
      "name": "",
      "creative_type": "image",
      "is_private": true,
      "creative_status": "active",
      "resource_url": "",
      "html_code": "",
      "width": 0,
      "height": 0,
      "email_from": "",
      "email_subject": "",
      "time_created": 0,
      "time_saved": 0,
      "additional_offer_ids": [
        0
      ],
      "is_apply_specific_affiliates": true
    }
  }
}

Update

PUT /v1/networks/custom/creative/:settingId

network_offer_creative_ids array[int]
network_affiliate_ids array[int]

The offer id.

custom_setting_status string

The custom setting status. Can be either active or inactive

name string

The custom cap setting name.

creative object
network_offer_id int

Only required when you create a new creative on its own (not part of an offer creation).

name string
creative_type string

Allowed values: image, html, thumbnail, email, archive, video, text.

is_private boolean
creative_status string

Allowed values: active, deleted.

html_code string

Only required when creative_type is ‘html’ or ‘email’.

width int

Only required when creative_type is ‘html’.

height int

Only required when creative_type is ‘html’.

email_from string

Only required when creative_type is ‘email’.

email_subject string

Only required when creative_type is ‘email’.

additional_offer_ids array[int]
is_apply_specific_affiliates boolean
resource_file object
temp_url string
original_file_name string
html_files array[object]
temp_url string
original_file_name string
html_assets array[object]
content_type string
filename string
url string
file_size int
image_width int
image_height int 

{
  "network_offer_creative_ids": [
    0
  ],
  "network_affiliate_ids": [
    0
  ],
  "name": "",
  "custom_setting_status": "active",
  "creative": {
    "network_offer_id": 0,
    "name": "",
    "creative_type": "image",
    "is_private": true,
    "creative_status": "active",
    "html_code": "",
    "width": 0,
    "height": 0,
    "email_from": "",
    "email_subject": "",
    "additional_offer_ids": [
      0
    ],
    "is_apply_specific_affiliates": true,
    "resource_file": {
      "temp_url": "",
      "original_file_name": ""
    },
    "html_files": [
      {
        "temp_url": "",
        "original_file_name": ""
      }
    ],
    "html_assets": [
      {
        "content_type": "",
        "filename": "",
        "url": "",
        "file_size": 0,
        "image_width": 0,
        "image_height": 0
      }
    ]
  }
}

cURL
curl --request POST \
  --url 'https://api.eflow.team/v1/networks/custom/creative/<INSERT SETTING ID>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'
Response
{
  "network_custom_creative_setting_id": 0,
  "network_id": 0,
  "network_offer_creative_ids": [
    0
  ],
  "network_affiliate_ids": [
    0
  ],
  "name": "",
  "custom_setting_status": "active",
  "time_created": 0,
  "time_saved": 0,
  "relationship": {
    "affiliates": [
      {
        "network_affiliate_id": 0,
        "network_id": 0,
        "name": "",
        "account_status": "active",
        "network_employee_id": 0,
        "internal_notes": "",
        "has_notifications": true,
        "network_traffic_source_id": 0,
        "account_executive_id": 0,
        "adress_id": 0,
        "default_currency_id": "",
        "is_contact_address_enabled": true,
        "enable_media_cost_tracking_links": true,
        "time_created": 0,
        "time_saved": 0,
        "referrer_id": 0
      }
    ],
    "creative": {
      "network_offer_creative_id": 0,
      "network_id": 0,
      "network_offer_id": 0,
      "name": "",
      "creative_type": "image",
      "is_private": true,
      "creative_status": "active",
      "resource_url": "",
      "html_code": "",
      "width": 0,
      "height": 0,
      "email_from": "",
      "email_subject": "",
      "time_created": 0,
      "time_saved": 0,
      "additional_offer_ids": [
        0
      ],
      "is_apply_specific_affiliates": true
    }
  }
}

Delete

DELETE /v1/networks/custom/creative/:settingId

Path Parameters

Parameter Description
settingId The ID of a network custom setting

cURL
curl --request DELETE \
  --url 'https://api.eflow.team/v1/networks/custom/scrubrate/<INSERT SETTING ID>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
Response
{
  "result": true
}

Patch

PATCH /v1/networks/custom/creative

network_custom_scrub_rate_setting_ids array[int]

List of network custom scrub rate setting ids separated by comas.

status string

Allowed values: active, inactive.

{
  "custom_creative_setting_ids": [
    0
  ],
  "status": "active"
}

cURL
curl --request PATCH \
  --url 'https://api.eflow.team/v1/networks/custom/creative' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'
Response
{
  "result": true
}