Creatives

Operations for creatives

Find All

GET /v1/networks/creatives

Paging

This endpoint supports paging. Refer to our User Guide for usage.

Filters

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

Value Description
network_offer_id Filter based on the creative’s offer id
creative_type Filter based on the creative’s type
creative_status Filter based on the creative’s status
time_created Filter based on the creation time
time_saved Filter based on the last update time

cURL
curl --request GET 'https://api.eflow.team/v1/networks/creatives' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
    "creatives": [
        {
            "network_offer_creative_id": 1,
            "network_id": 1,
            "network_offer_id": 73,
            "name": "test",
            "creative_type": "image",
            "is_private": false,
            "creative_status": "active",
            "resource_url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/1/testcreative.png",
            "html_code": "",
            "width": 0,
            "height": 0,
            "email_from": "",
            "email_subject": "",
            "time_created": 1602865402,
            "time_saved": 1602865403,
            "relationship": {
                "offer": {
                    "network_offer_id": 73,
                    "network_id": 1,
                    "network_advertiser_id": 39,
                    "network_offer_group_id": 0,
                    "name": "Candy Crush",
                    "offer_status": "active",
                    "network_tracking_domain_id": 1,
                    "visibility": "public",
                    "currency_id": "USD"
                },
                "resource_asset": {
                    "network_asset_id": 1,
                    "content_type": "image/png",
                    "filename": "testcreative.png",
                    "url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/1/testcreative.png",
                    "file_size": 5287,
                    "image_width": 0,
                    "image_height": 0
                }
            },
            "additional_offer_ids": null,
            "is_apply_specific_affiliates": false
        }
    ],
    "paging": {
        "page": 1,
        "page_size": 50,
        "total_count": 4
    }
}

Find By ID

GET /v1/networks/creatives/:creativeId

Path Parameters

Parameter Description
creativeId The ID of the creative you want to fetch

cURL
curl --request GET 'https://api.eflow.team/v1/networks/creatives/<INSERT CREATIVE ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>'
Response
{
    "network_offer_creative_id": 1,
    "network_id": 1,
    "network_offer_id": 73,
    "name": "test",
    "creative_type": "image",
    "is_private": false,
    "creative_status": "active",
    "resource_url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/1/testcreative.png",
    "html_code": "",
    "width": 0,
    "height": 0,
    "email_from": "",
    "email_subject": "",
    "time_created": 1602865402,
    "time_saved": 1602865403,
    "relationship": {
        "offer": {
            "network_offer_id": 73,
            "network_id": 1,
            "network_advertiser_id": 39,
            "network_offer_group_id": 0,
            "name": "Candy Crush",
            "offer_status": "active",
            "network_tracking_domain_id": 1,
            "visibility": "public",
            "currency_id": "USD"
        },
        "resource_asset": {
            "network_asset_id": 1,
            "content_type": "image/png",
            "filename": "testcreative.png",
            "url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/1/testcreative.png",
            "file_size": 5287,
            "image_width": 0,
            "image_height": 0
        }
    },
    "additional_offer_ids": null,
    "is_apply_specific_affiliates": false
}

Create

POST /v1/networks/creatives

network_offer_id int

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

name string

Name of the creative.

creative_type string

Type of the creative. Can be one of the following values: image, html, thumbnail, email, archive, video or text.

is_private boolean

Whether the creative is accessible by all affiliates.

creative_status string

Status of the creative. Can be either active or deleted.

html_code string

HTML content of the creative. Required only if creative_type is html or email.

width int

Width of the creative. Required only if creative_type is html.

height int

Height of the creative. Required only if creative_type is html.

email_from string

Content of the From field of the email. Required only if creative_type is email.

email_subject string

Content of the Subject field of the email. Required only if creative_type is email.

additional_offer_ids int array

ID of all offer linked to this creative.

is_apply_specific_affiliates boolean

Whether or not you want to apply to specific affiliates. Defaults to false.

resource_file object

Content of the creative. Should only be included if creative_type is image, thumbnail, archive or video.

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file

html_files object array

List of files attached to the creative. Should only be included if creative_type is html or email.

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file, which will be the used to generate the file macro. For example, Example File Name will give the macro {{example_file_name}}.

html_assets object array
content_type string

The type of content in the asset. //NOT SURE

filename string

Name of the file.

url string

URL of the file, obtained by uploading the file through the API.

file_size int

Size of the file.

image_width int

Width of the creative. Required only if creative_type is image.

image_height int

Height of the creative. Required only if creative_type is image.

{
    "network_offer_id": 73,
    "name": "",
    "creative_type": "image",
    "is_private": false,
    "creative_status": "active",
    "html_code": "",
    "width": 0,
    "height": 0,
    "email_from": "",
    "email_subject": "",
    "additional_offer_ids": [],
    "is_apply_specific_affiliates": false,
    "resource_file":
    {
        "temp_url": "https://usercontent-dev.everflowclient.io/1/temp/30e093f3-54bd-445f-9afb-291e506af466",
        "original_file_name": "original_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/creatives' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'
Response
{
    "network_offer_creative_id": 10,
    "network_id": 1,
    "network_offer_id": 73,
    "name": "",
    "creative_type": "image",
    "is_private": false,
    "creative_status": "active",
    "resource_url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/10/original_name",
    "html_code": "",
    "width": 0,
    "height": 0,
    "email_from": "",
    "email_subject": "",
    "time_created": 1603890208,
    "time_saved": 1603890209,
    "relationship": {
        "offer": {
            "network_offer_id": 73,
            "network_id": 1,
            "network_advertiser_id": 39,
            "network_offer_group_id": 0,
            "name": "Candy Crush",
            "offer_status": "active",
            "network_tracking_domain_id": 1,
            "visibility": "public",
            "currency_id": "USD"
        },
        "resource_asset": {
            "network_asset_id": 7,
            "content_type": "image/gif",
            "filename": "original_name",
            "url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/10/original_name",
            "file_size": 6,
            "image_width": 0,
            "image_height": 0
        }
    },
    "additional_offer_ids": null,
    "is_apply_specific_affiliates": false
}

Update

PUT /v1/networks/creatives/:creativeId

You must specify all the fields, not only the ones you wish to update.
If you omit a field that is not marked as required, its default value will be used.

Path Parameters

Parameter Description
creativeId The ID of the creative you want to update

network_offer_id int

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

name string

Name of the creative.

creative_type string

Type of the creative. Can be one of the following values: image, html, thumbnail, email, archive, video or text.

is_private boolean

Whether the creative is accessible by all affiliates.

creative_status string

Status of the creative. Can be either active or deleted.

html_code string

HTML content of the creative. Required only if creative_type is html or email.

width int

Width of the creative. Required only if creative_type is html.

height int

Height of the creative. Required only if creative_type is html.

email_from string

Content of the From field of the email. Required only if creative_type is email.

email_subject string

Content of the Subject field of the email. Required only if creative_type is email.

additional_offer_ids int array

ID of all offer linked to this creative.

is_apply_specific_affiliates boolean

Whether or not you want to apply to specific affiliates. Defaults to false.

resource_file object

Content of the creative. Should only be included if creative_type is image, thumbnail, archive or video.

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file

html_files object array

List of files attached to the creative. Should only be included if creative_type is html or email.

temp_url string

Temporary URL of the file, obtained by uploading the file through the API.

original_file_name string

Name of the file, which will be the used to generate the file macro. For example, Example File Name will give the macro {{example_file_name}}.

html_assets object array
content_type string

The type of content in the asset. //NOT SURE

filename string

Name of the file.

url string

URL of the file, obtained by uploading the file through the API.

file_size int

Size of the file.

image_width int

Width of the creative. Required only if creative_type is image.

image_height int

Height of the creative. Required only if creative_type is image.

{
    "network_offer_id": 73,
    "name": "",
    "creative_type": "image",
    "is_private": false,
    "creative_status": "active",
    "html_code": "",
    "width": 0,
    "height": 0,
    "email_from": "",
    "email_subject": "",
    "additional_offer_ids": [],
    "is_apply_specific_affiliates": false,
    "resource_file":
    {
        "temp_url": "https://usercontent-dev.everflowclient.io/1/temp/30e093f3-54bd-445f-9afb-291e506af466",
        "original_file_name": "original_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 PUT \
  --url 'https://api.eflow.team/v1/networks/creatives/<INSERT CREATIVE ID>' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'
Response
{
    "network_offer_creative_id": 10,
    "network_id": 1,
    "network_offer_id": 73,
    "name": "",
    "creative_type": "image",
    "is_private": false,
    "creative_status": "active",
    "resource_url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/10/original_name",
    "html_code": "",
    "width": 0,
    "height": 0,
    "email_from": "",
    "email_subject": "",
    "time_created": 1603890208,
    "time_saved": 1603890209,
    "relationship": {
        "offer": {
            "network_offer_id": 73,
            "network_id": 1,
            "network_advertiser_id": 39,
            "network_offer_group_id": 0,
            "name": "Candy Crush",
            "offer_status": "active",
            "network_tracking_domain_id": 1,
            "visibility": "public",
            "currency_id": "USD"
        },
        "resource_asset": {
            "network_asset_id": 7,
            "content_type": "image/gif",
            "filename": "original_name",
            "url": "https://usercontent-dev.everflowclient.io/1/offers/73/c/10/original_name",
            "file_size": 6,
            "image_width": 0,
            "image_height": 0
        }
    },
    "additional_offer_ids": null,
    "is_apply_specific_affiliates": false
}