Types of Creatives

Update creative (UYOA)

APIs for campaigns using Upload Your Own Assets (UYOA / SBT) as the asset source type.

Saves or updates a single creative variant for a retail campaign. Requires AssetSource_Create permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.

Sample Request

HTTP
    
 
POST http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/creative
Copy

Parameters

Field	Data Type	Requirement	Description
creativeName	string	Mandatory	Name of the creative variant to update.
clickthroughUrl	string	Optional	Click-through URL for the creative.
service	enum (string)	Optional	API operation type. Values: `ADD`, `UPDATE`
dynamicAssetsModified	boolean	Optional	Whether dynamic assets have been modified.
dynamicAssets	array	Optional	List of dynamic asset data entries (see below).
dspColumns	object	Optional	DSP-specific column mappings.
dataServiceId	integer	Optional	ID of the data service (asset source).
applyAllVariants	array of string	Optional	List of variant names to apply this creative update to.

dynamicAssets[] object (DynamicAssetDataRequest extends DynamicAssetData

Field	Data Type	Description
columnName	string	Name of the dynamic asset column.
columnValue	string	Value to set for the column.
adUnitTransformations	array	List of ad unit transformations to apply.
applyToAllVariants	boolean	Whether to apply this asset update to all variants (default: `false`).

Request Body

JSON
    
 
{  "creativeName": "variant_001",  "clickthroughUrl": "https://example.com/product-a",  "service": "UPDATE",  "dynamicAssetsModified": true,  "dynamicAssets": [    {      "columnName": "image_url",      "columnValue": "https://cdn.example.com/img/product-a.jpg",      "adUnitTransformations": [],      "applyToAllVariants": false    }  ],  "dataServiceId": 12345,  "applyAllVariants": ["variant_002", "variant_003"]}
Copy

Response

Returns an UpdateCreativeResponse JSON object.

Field	Data Type	Description
message	string	Result message from the metadata service.

Request Body

JSON
    
 
{  "message": "Creative updated successfully"}
Copy

Get creative list (UYOA)

Returns a paginated list of creatives for an SBT retail campaign. Only valid for campaigns with uploaded assets (SBT). Requires AssetSource_List permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.

Query Parameters

Name	Data Type	Requirement	Parameter Type	Description
filters	string	Optional	query	Filter string for the creative list (e.g. empty string for no filters).
limit	integer	Optional	query	Number of items per page (e.g. 100).
offset	integer	Optional	query	Pagination offset (e.g. 0).

Sample Request

HTTP
    
 
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/creatives
Copy

Response

Returns a paginated JSON object with a creatives array. Each item is a Creative object. Also includes ctaText at the top level if the campaign has agentic CTA text set.

Field	Data Type	Description
creatives	array	List of creative objects.
creatives[].creativeName	string	Name/key of the creative (from `dynamicAssetsTable.assetKey`).
creatives[].productImageUrl	string/null	URL of the product image for this creative.
creatives[].previewUrls	array	List of per-ad-unit preview URL objects.
creatives[].previewUrls[].adUnitId	integer	ID of the ad unit.
creatives[].previewUrls[].dimension	string	Dimension string of the ad unit (e.g. `300x250`).
creatives[].previewUrls[].url	string	CDN preview URL for the creative and ad unit.
creatives[].dspColumns	object/null	DSP-specific column data for the creative.
creatives[].assetData	object/null	Map of asset column names to their values (`Map<String, String>`).
count	integer	Total number of creatives.
next	string/null	URL for the next page of results.
previous	string/null	URL for the previous page of results.
ctaText	string	Agentic CTA text (only present if set for the campaign).

Request Body

JSON
    
 
{  "creatives": [    {      "creativeName": "variant_001",      "productImageUrl": "https://cdn.example.com/img/variant_001.jpg",      "previewUrls": [        {          "adUnitId": 55,          "dimension": "300x250",          "url": "https://cdn.example.com/16696/5373/55/dmFyaWFudF8wMDE=.html"        }      ],      "dspColumns": null,      "assetData": {        "image_url": "https://cdn.example.com/img/variant_001.jpg",        "headline": "Shop Now"      }    }  ],  "count": 1,  "next": null,  "previous": null,  "ctaText": "Shop Now"}
Copy

Get creative details (UYOA)

Returns the full details of a single creative variant for an SBT retail campaign, including its dynamic asset data, transformations, and DSP column mappings. Requires AssetSource_View permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.
creativeName	string	Mandatory	path	Name/key of the creative to fetch.

Sample Request

HTTP
    
 
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/creative/:creativeName
Copy

Response

Returns a CreativeDetails JSON object serialized via Jackson (toJsonWithoutNull).

Field	Data Type	Description
clickthroughUrl	string	Click-through URL for the creative.
dspColumns	object/null	DSP-specific column mappings for this creative.
dynamicAssets	array	URL of the product image for this creative.
dynamicAssets[].columnName	string	List of per-ad-unit preview URL objects.
dynamicAssets[].columnValue	string	Name of the dynamic asset column.
dynamicAssets[].adUnitTransformations	array	List of per-ad-unit asset transformations.
dynamicAssets[].adUnitTransformations[].adUnitId	integer	ID of the ad unit.
dynamicAssets[].adUnitTransformations[].transformations	array	List of `AssetTransformation` objects applied to this ad unit.
dynamicAssets[].adUnitTransformations[].transformations[].transformationIdx	integer	Index of the transformation.
dynamicAssets[].adUnitTransformations[].transformations[].advertiserIdx	integer	Advertiser index.
dynamicAssets[].adUnitTransformations[].transformations[].adIdx	integer	Ad index.
dynamicAssets[].adUnitTransformations[].transformations[].adUnitIdx	integer	Ad unit index.
dynamicAssets[].adUnitTransformations[].transformations[].assetId	string	Asset identifier.
dynamicAssets[].adUnitTransformations[].transformations[].dataServiceId	integer	Data service (asset source) ID.
dynamicAssets[].adUnitTransformations[].transformations[].assetProperty	string	Asset property name.
dynamicAssets[].adUnitTransformations[].transformations[].assetKey	string	Asset key (creative name).
dynamicAssets[].adUnitTransformations[].transformations[].data	object	Transformation-specific data map.
dynamicAssets[].adUnitTransformations[].transformations[].type	string	Asset transformation type.
dynamicAssets[].adUnitTransformations[].transformations[].isArchived	boolean	Whether the transformation is archived.
dynamicAssets[].adUnitTransformations[].transformations[].isActive	boolean	Whether the transformation is active.
dynamicAssets[].adUnitTransformations[].transformations[].versionId	integer	Version ID of the transformation.
dynamicAssets[].adUnitTransformations[].transformations[].transformationType	string	Transformation category type.
dynamicAssets[].adUnitTransformations[].transformations[].transformation	object	Transformation details object.

Request Body

JSON
    
 
{  "clickthroughUrl": "https://example.com/product/CV-010",  "dspColumns": null,  "dynamicAssets": [    {      "columnName": "image_url",      "columnValue": "https://cdn.example.com/img/CV-010.jpg",      "adUnitTransformations": [        {          "adUnitId": 55,          "transformations": [            {              "transformationIdx": 1,              "advertiserIdx": 16696,              "adIdx": 4321,              "adUnitIdx": 55,              "assetId": "asset-001",              "dataServiceId": 12345,              "assetProperty": "image_url",              "assetKey": "CV-010",              "data": { "crop": "center" },              "type": "IMAGE",              "isArchived": false,              "isActive": true,              "versionId": 1,              "transformationType": "CROP",              "transformation": {}            }          ]        }      ]    }  ]}
Copy

Update hybrid creative (Hybrid)

APIs for campaigns using Hybrid as the asset source type (combination of uploaded assets and retailer product feed).

Saves or updates a single hybrid creative variant, with separate product and creative dynamic asset lists. Requires AssetSource_Create permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.

Sample Request

HTTP
    
 
POST http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/hybrid-creative
Copy

Parameters

Field	Data Type	Requirement	Description
creativeName	string	Mandatory	Name/key of the creative variant.
service	enum (string)	Optional	API operation type. Values: `ADD`, `UPDATE`
dynamicAssetsModified	boolean	Optional	Whether dynamic assets have been modified.
productDynamicAssets	array	Optional	Dynamic asset entries for the product asset source (from RPF).
creativeDynamicAssets	array	Optional	Dynamic asset entries for the creative asset source (from UYOA).
adspColumns	object	Optional	Amazon DSP column mappings (`ADSPColumns`). See fields below.
clickthroughUrl	string	Optional	Click-through URL for the creative.
dataServiceId	integer	Optional	ID of the data service (asset source).
applyAllVariants	array of string	Optional	List of variant names to apply this update to

Both productDynamicAssets and creativeDynamicAssets follow the DynamicAssetDataRequest structure (columnName, columnValue, adUnitTransformations[], applyToAllVariants).

adspColumns object (ADSPColumns)

Field	Data Type	Description
productId	string	Amazon product ID.
productName	string	Product name.
productImage	string	Product image URL.
brand	string	Brand name.
recOptimizationGoal	integer	REC optimization goal.
recLogo	string	REC logo URL.
recHeadline	string	REC headline text.
recDisclaimer	string	REC disclaimer text.

Request Body

JSON
    
 
{  "creativeName": "hybrid_variant_001",  "service": "UPDATE",  "dynamicAssetsModified": true,  "productDynamicAssets": [    {      "columnName": "product_image",      "columnValue": "https://cdn.example.com/products/001.jpg",      "adUnitTransformations": [],      "applyToAllVariants": false    }  ],  "creativeDynamicAssets": [    {      "columnName": "headline",      "columnValue": "Shop the Summer Sale",      "adUnitTransformations": [],      "applyToAllVariants": false    }  ],  "clickthroughUrl": "https://example.com/summer",  "dataServiceId": 12345}
Copy

Response

Field	Data Type	Description
message	string	Result message from the metadata service.

Request Body

JSON
    
 
{  "message": "Hybrid creative updated successfully"}
Copy

Add hybrid creatives

Initialises multiple hybrid creative variants by name for a retail campaign. Requires AssetSource_Create permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.

Parameters

Field	Data Type	Requirement	Description
creativeNames	array of string	Mandatory	List of creative variant names to initialise/add.

Sample Request

HTTP
    
 
POST http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/hybrid-creatives
Copy

Request Body

JSON
    
 
{  "creativeNames": ["hybrid_variant_001", "hybrid_variant_002", "hybrid_variant_003"]}
Copy

Response

Field	Data Type	Description
message	string	Result message from the metadata service.

Request Body

JSON
    
 
{  "message": "Hybrid creatives added successfully"}
Copy

Get hybrid creative details

Returns the full details of a single hybrid creative variant, including separate product and creative dynamic asset lists and Amazon DSP column mappings. Requires AssetSource_View permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.
creativeName	string	Mandatory	path	Name/key of the hybrid creative.

Sample Request

HTTP
    
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/hybrid-creative/:creativeName
Copy

Response

Returns a HybridCreativeDetails JSON object serialized via Jackson (toJsonWithoutNull).

Field	Data Type	Description
clickThroughUrl	string	Click-through URL for the creative.
productDynamicAssets	array	Dynamic asset entries from the product (RPF) asset source.
productDynamicAssets[].columnName	string	Asset column name.
productDynamicAssets[].columnValue	string	Asset column value.
productDynamicAssets[].adUnitTransformations	array	Per-ad-unit transformations (same structure as `CreativeDetails`).
creativeDynamicAssets	array	Dynamic asset entries from the creative (UYOA) asset source.
creativeDynamicAssets[].columnName	string	Asset column name.
creativeDynamicAssets[].columnValue	string	Asset column value.
creativeDynamicAssets[].adUnitTransformations	array	Per-ad-unit transformations.
adspColumns	object/null	Amazon DSP column mappings (`ADSPColumns`). Fields: `productId`, `productName`, `productImage`, `brand`, `recOptimizationGoal`, `recLogo`, `recHeadline`, `recDisclaimer`.

Request Body

JSON
    
 
{  "clickThroughUrl": "https://example.com/product/hybrid-001",  "productDynamicAssets": [    {      "columnName": "product_image",      "columnValue": "https://cdn.example.com/products/001.jpg",      "adUnitTransformations": []    }  ],  "creativeDynamicAssets": [    {      "columnName": "headline",      "columnValue": "Shop the Summer Sale",      "adUnitTransformations": []    }  ],  "adspColumns": {    "productId": "PROD-001",    "productName": "Summer Tee",    "productImage": "https://cdn.example.com/img/001.jpg",    "brand": "BrandA",    "recOptimizationGoal": "clicks",    "recLogo": "https://cdn.example.com/logos/brandA.png",    "recHeadline": "Best Sellers",    "recDisclaimer": null  }}
Copy

List campaign brand values (RPF/HYBRID)

Returns a list of distinct brand values available within a specific retail campaign, optionally filtered by a search keyword. Requires Campaigns_Create permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.

Query Parameters

Name	Data Type	Requirement	Default	Description
searchKeyword	string	Optional	`""`	Keyword to filter brand values by name.

Sample Request

HTTP
    
 
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/brands?searchKeyword=Nike
Copy

Response (Values)

Field	Data Type	Description
values	array of string	List of matching brand name strings.

Request Body

JSON
    
 
{  "values": ["Nike", "Adidas", "Puma"]}
Copy

List brand values (RPF/HYBRID)

Returns a list of distinct brand values across all RPF campaigns for the account, filtered by one or more search queries. Requires AdvertiserSettings_All permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.

Query Parameters

Name	Data Type	Requirement	Description
query	string	Mandatory	Comma-separated list of search terms to filter brand values (e.g. `Nike,Puma`).
limit	integer	Mandatory	Maximum number of values to return.
offset	integer	Mandatory	Number of values to skip (for pagination).

Sample Request

HTTP
    
 
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-settings/brands?query=Nike,Puma&limit=25&offset=0
Copy

Response (Values)

Field	Data Type	Description
values	array of string	List of matching brand name strings.

Request Body

JSON
    
 
{  "values": ["Nike", "Puma"]}
Copy

List product content field values (RPF/HYBRID)

Returns paginated values for a specific product content field within a retail campaign, filtered by search query and optional brand filter. Requires AssetSource_List permission.

Path Parameters

Name	Data Type	Requirement	Parameter Type	Description
accountId	string	Mandatory	path	ID of the account.
retailCampaignIdx	integer	Mandatory	path	Index of the retail campaign.

Query Parameters

Name	Data Type	Requirement	Description
field	string	Mandatory	The `RMAProductContentType` enum value identifying the field to query (e.g. `BRAND`, `PRODUCT_NAME`).
query	string	Mandatory	Comma-separated search terms to filter field values.
limit	integer	Mandatory	Maximum number of values to return.
offset	integer	Mandatory	Number of values to skip (for pagination).
brandFilter	string	Optional	Comma-separated brand names to additionally filter results by brand.

Sample Request

HTTP
    
GET http://demo.stub.api.jivox.com/v2/accounts/:accountId/retail-campaigns/:retailCampaignIdx/product-content?field=BRAND&query=Nik&limit=25&offset=0&brandFilter=Nike
Copy

Response (HybridContentValues)

Field	Data Type	Description
values	array	List of `HybridProductContent` objects matching the query.
values[].productId	string	Product identifier.
values[].contentValue	string	Raw value for the requested field.
values[].displayValue	string	Human-readable display value for the field.
values[].productImageUrl	string	URL of the product thumbnail image.
values[].previewUrls	array	List of `AdUnitPreviewUrl` objects for ad unit previews.

Request Body

JSON
    
 
{  "values": [    {      "productId": "PROD-001",      "contentValue": "Nike Air Max",      "displayValue": "Nike Air Max",      "productImageUrl": "https://cdn.example.com/products/001.jpg",      "previewUrls": []    },    {      "productId": "PROD-002",      "contentValue": "Nike Free Run",      "displayValue": "Nike Free Run",      "productImageUrl": "https://cdn.example.com/products/002.jpg",      "previewUrls": []    }  ]}
Copy

Last updated on

Was this page helpful?