Update a campaign creative

curl --request PUT \
  --url https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expectedRevision": 4503599627370495,
  "name": "<string>",
  "sourceAssets": [],
  "copy": {},
  "clickUrl": "<string>",
  "message": "<string>",
  "carouselCards": [
    {
      "assetId": "<string>",
      "headline": "<string>",
      "description": "<string>",
      "cta": "<string>",
      "landingPageUrl": "<string>"
    }
  ],
  "frequencyCaps": [
    {
      "max_impressions": 123,
      "window": {
        "interval": 123
      }
    }
  ]
}
'

import requests

url = "https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid}"

payload = {
    "expectedRevision": 4503599627370495,
    "name": "<string>",
    "sourceAssets": [],
    "copy": {},
    "clickUrl": "<string>",
    "message": "<string>",
    "carouselCards": [
        {
            "assetId": "<string>",
            "headline": "<string>",
            "description": "<string>",
            "cta": "<string>",
            "landingPageUrl": "<string>"
        }
    ],
    "frequencyCaps": [
        {
            "max_impressions": 123,
            "window": { "interval": 123 }
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    expectedRevision: 4503599627370495,
    name: '<string>',
    sourceAssets: [],
    copy: {},
    clickUrl: '<string>',
    message: '<string>',
    carouselCards: [
      {
        assetId: '<string>',
        headline: '<string>',
        description: '<string>',
        cta: '<string>',
        landingPageUrl: '<string>'
      }
    ],
    frequencyCaps: [{max_impressions: 123, window: {interval: 123}}]
  })
};

fetch('https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'expectedRevision' => 4503599627370495,
    'name' => '<string>',
    'sourceAssets' => [
        
    ],
    'copy' => [
        
    ],
    'clickUrl' => '<string>',
    'message' => '<string>',
    'carouselCards' => [
        [
                'assetId' => '<string>',
                'headline' => '<string>',
                'description' => '<string>',
                'cta' => '<string>',
                'landingPageUrl' => '<string>'
        ]
    ],
    'frequencyCaps' => [
        [
                'max_impressions' => 123,
                'window' => [
                                'interval' => 123
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid}"

	payload := strings.NewReader("{\n  \"expectedRevision\": 4503599627370495,\n  \"name\": \"<string>\",\n  \"sourceAssets\": [],\n  \"copy\": {},\n  \"clickUrl\": \"<string>\",\n  \"message\": \"<string>\",\n  \"carouselCards\": [\n    {\n      \"assetId\": \"<string>\",\n      \"headline\": \"<string>\",\n      \"description\": \"<string>\",\n      \"cta\": \"<string>\",\n      \"landingPageUrl\": \"<string>\"\n    }\n  ],\n  \"frequencyCaps\": [\n    {\n      \"max_impressions\": 123,\n      \"window\": {\n        \"interval\": 123\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expectedRevision\": 4503599627370495,\n  \"name\": \"<string>\",\n  \"sourceAssets\": [],\n  \"copy\": {},\n  \"clickUrl\": \"<string>\",\n  \"message\": \"<string>\",\n  \"carouselCards\": [\n    {\n      \"assetId\": \"<string>\",\n      \"headline\": \"<string>\",\n      \"description\": \"<string>\",\n      \"cta\": \"<string>\",\n      \"landingPageUrl\": \"<string>\"\n    }\n  ],\n  \"frequencyCaps\": [\n    {\n      \"max_impressions\": 123,\n      \"window\": {\n        \"interval\": 123\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expectedRevision\": 4503599627370495,\n  \"name\": \"<string>\",\n  \"sourceAssets\": [],\n  \"copy\": {},\n  \"clickUrl\": \"<string>\",\n  \"message\": \"<string>\",\n  \"carouselCards\": [\n    {\n      \"assetId\": \"<string>\",\n      \"headline\": \"<string>\",\n      \"description\": \"<string>\",\n      \"cta\": \"<string>\",\n      \"landingPageUrl\": \"<string>\"\n    }\n  ],\n  \"frequencyCaps\": [\n    {\n      \"max_impressions\": 123,\n      \"window\": {\n        \"interval\": 123\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "advertiserId": 123,
    "name": "<string>",
    "state": "draft",
    "formatKind": "image",
    "formatId": {
      "agentUrl": "<string>",
      "id": "<string>",
      "width": 123,
      "height": 123,
      "durationMs": 123
    },
    "formatLabel": "<string>",
    "slots": [
      {
        "slotId": "<string>",
        "kind": "asset",
        "assetId": "<string>",
        "value": "<string>",
        "crop": true
      }
    ],
    "copy": {},
    "clickUrl": "<string>",
    "trackers": {},
    "message": "<string>",
    "urlAsset": {
      "url": "<string>",
      "urlType": "clickthrough",
      "vastVersion": "2.0"
    },
    "webhookAsset": {
      "url": "<string>",
      "method": "POST",
      "timeoutMs": 500,
      "responseType": "json",
      "security": {
        "method": "none"
      }
    },
    "carouselCards": [
      {
        "assetId": "<string>",
        "headline": "<string>",
        "description": "<string>",
        "cta": "<string>",
        "landingPageUrl": "<string>"
      }
    ],
    "role": "evergreen",
    "promoted": true,
    "revision": 4503599627370495,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "frequencyCaps": [
      {
        "id": "<string>",
        "targetLevel": "ADVERTISER",
        "targetId": "<string>",
        "max_impressions": 123,
        "window": {
          "interval": 123,
          "unit": "minutes"
        },
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "archivedAt": "<string>"
      }
    ],
    "frequencyCapsNote": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": "<unknown>"
  }
}

PUT

api

buyer

campaigns

{id}

creatives

{cid}

Update a campaign creative

curl --request PUT \
  --url https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expectedRevision": 4503599627370495,
  "name": "<string>",
  "sourceAssets": [],
  "copy": {},
  "clickUrl": "<string>",
  "message": "<string>",
  "carouselCards": [
    {
      "assetId": "<string>",
      "headline": "<string>",
      "description": "<string>",
      "cta": "<string>",
      "landingPageUrl": "<string>"
    }
  ],
  "frequencyCaps": [
    {
      "max_impressions": 123,
      "window": {
        "interval": 123
      }
    }
  ]
}
'

import requests

url = "https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid}"

payload = {
    "expectedRevision": 4503599627370495,
    "name": "<string>",
    "sourceAssets": [],
    "copy": {},
    "clickUrl": "<string>",
    "message": "<string>",
    "carouselCards": [
        {
            "assetId": "<string>",
            "headline": "<string>",
            "description": "<string>",
            "cta": "<string>",
            "landingPageUrl": "<string>"
        }
    ],
    "frequencyCaps": [
        {
            "max_impressions": 123,
            "window": { "interval": 123 }
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    expectedRevision: 4503599627370495,
    name: '<string>',
    sourceAssets: [],
    copy: {},
    clickUrl: '<string>',
    message: '<string>',
    carouselCards: [
      {
        assetId: '<string>',
        headline: '<string>',
        description: '<string>',
        cta: '<string>',
        landingPageUrl: '<string>'
      }
    ],
    frequencyCaps: [{max_impressions: 123, window: {interval: 123}}]
  })
};

fetch('https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'expectedRevision' => 4503599627370495,
    'name' => '<string>',
    'sourceAssets' => [
        
    ],
    'copy' => [
        
    ],
    'clickUrl' => '<string>',
    'message' => '<string>',
    'carouselCards' => [
        [
                'assetId' => '<string>',
                'headline' => '<string>',
                'description' => '<string>',
                'cta' => '<string>',
                'landingPageUrl' => '<string>'
        ]
    ],
    'frequencyCaps' => [
        [
                'max_impressions' => 123,
                'window' => [
                                'interval' => 123
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid}"

	payload := strings.NewReader("{\n  \"expectedRevision\": 4503599627370495,\n  \"name\": \"<string>\",\n  \"sourceAssets\": [],\n  \"copy\": {},\n  \"clickUrl\": \"<string>\",\n  \"message\": \"<string>\",\n  \"carouselCards\": [\n    {\n      \"assetId\": \"<string>\",\n      \"headline\": \"<string>\",\n      \"description\": \"<string>\",\n      \"cta\": \"<string>\",\n      \"landingPageUrl\": \"<string>\"\n    }\n  ],\n  \"frequencyCaps\": [\n    {\n      \"max_impressions\": 123,\n      \"window\": {\n        \"interval\": 123\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"expectedRevision\": 4503599627370495,\n  \"name\": \"<string>\",\n  \"sourceAssets\": [],\n  \"copy\": {},\n  \"clickUrl\": \"<string>\",\n  \"message\": \"<string>\",\n  \"carouselCards\": [\n    {\n      \"assetId\": \"<string>\",\n      \"headline\": \"<string>\",\n      \"description\": \"<string>\",\n      \"cta\": \"<string>\",\n      \"landingPageUrl\": \"<string>\"\n    }\n  ],\n  \"frequencyCaps\": [\n    {\n      \"max_impressions\": 123,\n      \"window\": {\n        \"interval\": 123\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.semicola.com/api/v2/buyer/campaigns/{id}/creatives/{cid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"expectedRevision\": 4503599627370495,\n  \"name\": \"<string>\",\n  \"sourceAssets\": [],\n  \"copy\": {},\n  \"clickUrl\": \"<string>\",\n  \"message\": \"<string>\",\n  \"carouselCards\": [\n    {\n      \"assetId\": \"<string>\",\n      \"headline\": \"<string>\",\n      \"description\": \"<string>\",\n      \"cta\": \"<string>\",\n      \"landingPageUrl\": \"<string>\"\n    }\n  ],\n  \"frequencyCaps\": [\n    {\n      \"max_impressions\": 123,\n      \"window\": {\n        \"interval\": 123\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "advertiserId": 123,
    "name": "<string>",
    "state": "draft",
    "formatKind": "image",
    "formatId": {
      "agentUrl": "<string>",
      "id": "<string>",
      "width": 123,
      "height": 123,
      "durationMs": 123
    },
    "formatLabel": "<string>",
    "slots": [
      {
        "slotId": "<string>",
        "kind": "asset",
        "assetId": "<string>",
        "value": "<string>",
        "crop": true
      }
    ],
    "copy": {},
    "clickUrl": "<string>",
    "trackers": {},
    "message": "<string>",
    "urlAsset": {
      "url": "<string>",
      "urlType": "clickthrough",
      "vastVersion": "2.0"
    },
    "webhookAsset": {
      "url": "<string>",
      "method": "POST",
      "timeoutMs": 500,
      "responseType": "json",
      "security": {
        "method": "none"
      }
    },
    "carouselCards": [
      {
        "assetId": "<string>",
        "headline": "<string>",
        "description": "<string>",
        "cta": "<string>",
        "landingPageUrl": "<string>"
      }
    ],
    "role": "evergreen",
    "promoted": true,
    "revision": 4503599627370495,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "frequencyCaps": [
      {
        "id": "<string>",
        "targetLevel": "ADVERTISER",
        "targetId": "<string>",
        "max_impressions": 123,
        "window": {
          "interval": 123,
          "unit": "minutes"
        },
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "archivedAt": "<string>"
      }
    ],
    "frequencyCapsNote": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

API key or OAuth access token.

Path Parameters

string

required

Minimum string length: 1

cid

string

required

Minimum string length: 1

Body

application/json

expectedRevision

integer

required

Required range: 0 <= x <= 9007199254740991

name

string

Required string length: 1 - 200

formatKind

enum<string>

Available options:

image,

html5,

display_tag,

image_carousel,

video_hosted,

video_vast,

audio_hosted,

audio_daast,

sponsored_placement,

native_in_feed,

responsive_creative,

agent_placement,

custom

formatId

object

Show child attributes

sourceAssets

object[]

Show child attributes

copy

object

Show child attributes

clickUrl

string<uri>

mode

enum<string>

Available options:

draft,

complete

message

string

Maximum string length: 2000

urlAsset

object

Show child attributes

webhookAsset

object

Show child attributes

carouselCards

object[]

Maximum array length: 10

Show child attributes

frequencyCaps

object[]

Show child attributes

Response

data

object | null

required

Show child attributes

error

object | null

required

Show child attributes

v3

Concepts

Agents

Skills

Buyer API reference

Storefront API reference

v3 API reference

Update a campaign creative

Authorizations

Path Parameters

Body

Response