Update a creative.
The user must be authenticated and have write permissions to the template site group.
Request
The request object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
Yes |
Identifier for the creative. |
|
|
String |
No |
The creative name. |
|
|
Array of Element objects |
No |
The creative elements. |
|
|
String or ClearableField |
No |
The identifier of the product this creative is affiliated with. |
The ClearableField object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
Boolean |
Yes |
The value |
Each Element object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
Yes |
The name of the element. |
|
|
String |
Yes |
The type of element, either |
The elements should correspond in name and type with elements from the template. All elements marked as required in the template must be present.
Image type
When type is image, the element additionally has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
No* |
Image id of a previously uploaded image. |
|
|
String |
No* |
Base64 encoded image data. Image dimensions must match the width and height from the template. |
|
|
String |
No* |
Image filename with an appropriate file extension, either |
* Either id alone, or both data and filename must be provided. If id is provided, it must match the existing image id for this element, and the element will be left unchanged.
Text type
When type is text, the element additionally has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
Yes |
The text that will be delivered to the end user. |
URL type
When type is url, the element additionally has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
Yes |
The URL that will be delivered to the end user. |
Response
The response object is the empty object.