Update Campaign By Id

curl --request PATCH \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Bola-Bola Ad campaign",
  "budget": {
    "amount": "<unknown>"
  },
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "isActive": true,
  "isSmart": true,
  "campaignType": "autobidding",
  "statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isAutoTrigger": true,
  "targetRoas": 15.25,
  "externalCampaignId": "<string>",
  "productIds": [
    "<string>"
  ],
  "bannerAdRejectionReason": {
    "declineReason": "<string>",
    "reasonDetails": "<string>"
  },
  "fallbackWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "multiplierConfig": {
    "isActive": true,
    "multipliers": [
      {
        "type": "user_segment",
        "segmentId": "<string>",
        "multiplier": 0.5
      }
    ]
  },
  "targetingFilters": {
    "isActive": true,
    "targetingFilters": [
      {
        "type": "user_segment",
        "segmentId": "<string>"
      }
    ]
  },
  "exclusionFilters": {
    "isActive": true,
    "exclusionFilters": [
      {
        "type": "user_segment",
        "segmentId": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}"

payload = {
    "name": "Bola-Bola Ad campaign",
    "budget": { "amount": "<unknown>" },
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "isActive": True,
    "isSmart": True,
    "campaignType": "autobidding",
    "statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isAutoTrigger": True,
    "targetRoas": 15.25,
    "externalCampaignId": "<string>",
    "productIds": ["<string>"],
    "bannerAdRejectionReason": {
        "declineReason": "<string>",
        "reasonDetails": "<string>"
    },
    "fallbackWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "multiplierConfig": {
        "isActive": True,
        "multipliers": [
            {
                "type": "user_segment",
                "segmentId": "<string>",
                "multiplier": 0.5
            }
        ]
    },
    "targetingFilters": {
        "isActive": True,
        "targetingFilters": [
            {
                "type": "user_segment",
                "segmentId": "<string>"
            }
        ]
    },
    "exclusionFilters": {
        "isActive": True,
        "exclusionFilters": [
            {
                "type": "user_segment",
                "segmentId": "<string>"
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Bola-Bola Ad campaign',
    budget: {amount: '<unknown>'},
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z',
    isActive: true,
    isSmart: true,
    campaignType: 'autobidding',
    statusUpdatedBy: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    isAutoTrigger: true,
    targetRoas: 15.25,
    externalCampaignId: '<string>',
    productIds: ['<string>'],
    bannerAdRejectionReason: {declineReason: '<string>', reasonDetails: '<string>'},
    fallbackWalletId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    multiplierConfig: {
      isActive: true,
      multipliers: [{type: 'user_segment', segmentId: '<string>', multiplier: 0.5}]
    },
    targetingFilters: {
      isActive: true,
      targetingFilters: [{type: 'user_segment', segmentId: '<string>'}]
    },
    exclusionFilters: {
      isActive: true,
      exclusionFilters: [{type: 'user_segment', segmentId: '<string>'}]
    }
  })
};

fetch('https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}', 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.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Bola-Bola Ad campaign',
    'budget' => [
        'amount' => '<unknown>'
    ],
    'startDate' => '2023-11-07T05:31:56Z',
    'endDate' => '2023-11-07T05:31:56Z',
    'isActive' => true,
    'isSmart' => true,
    'campaignType' => 'autobidding',
    'statusUpdatedBy' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'isAutoTrigger' => true,
    'targetRoas' => 15.25,
    'externalCampaignId' => '<string>',
    'productIds' => [
        '<string>'
    ],
    'bannerAdRejectionReason' => [
        'declineReason' => '<string>',
        'reasonDetails' => '<string>'
    ],
    'fallbackWalletId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'multiplierConfig' => [
        'isActive' => true,
        'multipliers' => [
                [
                                'type' => 'user_segment',
                                'segmentId' => '<string>',
                                'multiplier' => 0.5
                ]
        ]
    ],
    'targetingFilters' => [
        'isActive' => true,
        'targetingFilters' => [
                [
                                'type' => 'user_segment',
                                'segmentId' => '<string>'
                ]
        ]
    ],
    'exclusionFilters' => [
        'isActive' => true,
        'exclusionFilters' => [
                [
                                'type' => 'user_segment',
                                'segmentId' => '<string>'
                ]
        ]
    ]
  ]),
  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.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}"

	payload := strings.NewReader("{\n  \"name\": \"Bola-Bola Ad campaign\",\n  \"budget\": {\n    \"amount\": \"<unknown>\"\n  },\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"isActive\": true,\n  \"isSmart\": true,\n  \"campaignType\": \"autobidding\",\n  \"statusUpdatedBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"isAutoTrigger\": true,\n  \"targetRoas\": 15.25,\n  \"externalCampaignId\": \"<string>\",\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"bannerAdRejectionReason\": {\n    \"declineReason\": \"<string>\",\n    \"reasonDetails\": \"<string>\"\n  },\n  \"fallbackWalletId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"multiplierConfig\": {\n    \"isActive\": true,\n    \"multipliers\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\",\n        \"multiplier\": 0.5\n      }\n    ]\n  },\n  \"targetingFilters\": {\n    \"isActive\": true,\n    \"targetingFilters\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\"\n      }\n    ]\n  },\n  \"exclusionFilters\": {\n    \"isActive\": true,\n    \"exclusionFilters\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Bola-Bola Ad campaign\",\n  \"budget\": {\n    \"amount\": \"<unknown>\"\n  },\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"isActive\": true,\n  \"isSmart\": true,\n  \"campaignType\": \"autobidding\",\n  \"statusUpdatedBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"isAutoTrigger\": true,\n  \"targetRoas\": 15.25,\n  \"externalCampaignId\": \"<string>\",\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"bannerAdRejectionReason\": {\n    \"declineReason\": \"<string>\",\n    \"reasonDetails\": \"<string>\"\n  },\n  \"fallbackWalletId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"multiplierConfig\": {\n    \"isActive\": true,\n    \"multipliers\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\",\n        \"multiplier\": 0.5\n      }\n    ]\n  },\n  \"targetingFilters\": {\n    \"isActive\": true,\n    \"targetingFilters\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\"\n      }\n    ]\n  },\n  \"exclusionFilters\": {\n    \"isActive\": true,\n    \"exclusionFilters\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Bola-Bola Ad campaign\",\n  \"budget\": {\n    \"amount\": \"<unknown>\"\n  },\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"isActive\": true,\n  \"isSmart\": true,\n  \"campaignType\": \"autobidding\",\n  \"statusUpdatedBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"isAutoTrigger\": true,\n  \"targetRoas\": 15.25,\n  \"externalCampaignId\": \"<string>\",\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"bannerAdRejectionReason\": {\n    \"declineReason\": \"<string>\",\n    \"reasonDetails\": \"<string>\"\n  },\n  \"fallbackWalletId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"multiplierConfig\": {\n    \"isActive\": true,\n    \"multipliers\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\",\n        \"multiplier\": 0.5\n      }\n    ]\n  },\n  \"targetingFilters\": {\n    \"isActive\": true,\n    \"targetingFilters\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\"\n      }\n    ]\n  },\n  \"exclusionFilters\": {\n    \"isActive\": true,\n    \"exclusionFilters\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\"\n      }\n    ]\n  }\n}"

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

{
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Bola-Bola Ad campaign",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "isActive": true,
  "isSmart": true,
  "campaignType": "manual",
  "status": "approved",
  "createdAt": "2023-11-07T05:31:56Z",
  "chargeType": "CPM",
  "externalVendorId": "<string>",
  "adFormat": "listing",
  "isAutoTrigger": true,
  "vendorId": "<string>",
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bidCount": 123,
  "budget": {
    "amount": 1000,
    "amountRemaining": 123,
    "amountCarryover": 123,
    "amountUsed": 123,
    "type": "daily"
  },
  "statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaignBehaviorData": "<string>",
  "campaignBehaviorDataByDay": "<string>",
  "exclusivityPrice": 123,
  "targetRoas": 123,
  "externalCampaignId": "<string>",
  "autobiddingObjective": "impressions",
  "mediaType": "video",
  "fallbackWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "multiplierConfig": {
    "isActive": true,
    "multipliers": [
      {
        "type": "user_segment",
        "segmentId": "<string>",
        "multiplier": 0.5
      }
    ]
  },
  "targetingFilters": {
    "isActive": true,
    "targetingFilters": [
      {
        "type": "user_segment",
        "segmentId": "<string>"
      }
    ]
  },
  "exclusionFilters": {
    "isActive": true,
    "exclusionFilters": [
      {
        "type": "user_segment",
        "segmentId": "<string>"
      }
    ]
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PATCH

public

campaign-service

campaigns

{campaign_id}

Update Campaign By Id

curl --request PATCH \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Bola-Bola Ad campaign",
  "budget": {
    "amount": "<unknown>"
  },
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "isActive": true,
  "isSmart": true,
  "campaignType": "autobidding",
  "statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isAutoTrigger": true,
  "targetRoas": 15.25,
  "externalCampaignId": "<string>",
  "productIds": [
    "<string>"
  ],
  "bannerAdRejectionReason": {
    "declineReason": "<string>",
    "reasonDetails": "<string>"
  },
  "fallbackWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "multiplierConfig": {
    "isActive": true,
    "multipliers": [
      {
        "type": "user_segment",
        "segmentId": "<string>",
        "multiplier": 0.5
      }
    ]
  },
  "targetingFilters": {
    "isActive": true,
    "targetingFilters": [
      {
        "type": "user_segment",
        "segmentId": "<string>"
      }
    ]
  },
  "exclusionFilters": {
    "isActive": true,
    "exclusionFilters": [
      {
        "type": "user_segment",
        "segmentId": "<string>"
      }
    ]
  }
}
'

import requests

url = "https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}"

payload = {
    "name": "Bola-Bola Ad campaign",
    "budget": { "amount": "<unknown>" },
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "isActive": True,
    "isSmart": True,
    "campaignType": "autobidding",
    "statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isAutoTrigger": True,
    "targetRoas": 15.25,
    "externalCampaignId": "<string>",
    "productIds": ["<string>"],
    "bannerAdRejectionReason": {
        "declineReason": "<string>",
        "reasonDetails": "<string>"
    },
    "fallbackWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "multiplierConfig": {
        "isActive": True,
        "multipliers": [
            {
                "type": "user_segment",
                "segmentId": "<string>",
                "multiplier": 0.5
            }
        ]
    },
    "targetingFilters": {
        "isActive": True,
        "targetingFilters": [
            {
                "type": "user_segment",
                "segmentId": "<string>"
            }
        ]
    },
    "exclusionFilters": {
        "isActive": True,
        "exclusionFilters": [
            {
                "type": "user_segment",
                "segmentId": "<string>"
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Bola-Bola Ad campaign',
    budget: {amount: '<unknown>'},
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z',
    isActive: true,
    isSmart: true,
    campaignType: 'autobidding',
    statusUpdatedBy: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    isAutoTrigger: true,
    targetRoas: 15.25,
    externalCampaignId: '<string>',
    productIds: ['<string>'],
    bannerAdRejectionReason: {declineReason: '<string>', reasonDetails: '<string>'},
    fallbackWalletId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    multiplierConfig: {
      isActive: true,
      multipliers: [{type: 'user_segment', segmentId: '<string>', multiplier: 0.5}]
    },
    targetingFilters: {
      isActive: true,
      targetingFilters: [{type: 'user_segment', segmentId: '<string>'}]
    },
    exclusionFilters: {
      isActive: true,
      exclusionFilters: [{type: 'user_segment', segmentId: '<string>'}]
    }
  })
};

fetch('https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}', 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.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Bola-Bola Ad campaign',
    'budget' => [
        'amount' => '<unknown>'
    ],
    'startDate' => '2023-11-07T05:31:56Z',
    'endDate' => '2023-11-07T05:31:56Z',
    'isActive' => true,
    'isSmart' => true,
    'campaignType' => 'autobidding',
    'statusUpdatedBy' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'isAutoTrigger' => true,
    'targetRoas' => 15.25,
    'externalCampaignId' => '<string>',
    'productIds' => [
        '<string>'
    ],
    'bannerAdRejectionReason' => [
        'declineReason' => '<string>',
        'reasonDetails' => '<string>'
    ],
    'fallbackWalletId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'multiplierConfig' => [
        'isActive' => true,
        'multipliers' => [
                [
                                'type' => 'user_segment',
                                'segmentId' => '<string>',
                                'multiplier' => 0.5
                ]
        ]
    ],
    'targetingFilters' => [
        'isActive' => true,
        'targetingFilters' => [
                [
                                'type' => 'user_segment',
                                'segmentId' => '<string>'
                ]
        ]
    ],
    'exclusionFilters' => [
        'isActive' => true,
        'exclusionFilters' => [
                [
                                'type' => 'user_segment',
                                'segmentId' => '<string>'
                ]
        ]
    ]
  ]),
  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.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}"

	payload := strings.NewReader("{\n  \"name\": \"Bola-Bola Ad campaign\",\n  \"budget\": {\n    \"amount\": \"<unknown>\"\n  },\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"isActive\": true,\n  \"isSmart\": true,\n  \"campaignType\": \"autobidding\",\n  \"statusUpdatedBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"isAutoTrigger\": true,\n  \"targetRoas\": 15.25,\n  \"externalCampaignId\": \"<string>\",\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"bannerAdRejectionReason\": {\n    \"declineReason\": \"<string>\",\n    \"reasonDetails\": \"<string>\"\n  },\n  \"fallbackWalletId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"multiplierConfig\": {\n    \"isActive\": true,\n    \"multipliers\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\",\n        \"multiplier\": 0.5\n      }\n    ]\n  },\n  \"targetingFilters\": {\n    \"isActive\": true,\n    \"targetingFilters\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\"\n      }\n    ]\n  },\n  \"exclusionFilters\": {\n    \"isActive\": true,\n    \"exclusionFilters\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Bola-Bola Ad campaign\",\n  \"budget\": {\n    \"amount\": \"<unknown>\"\n  },\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"isActive\": true,\n  \"isSmart\": true,\n  \"campaignType\": \"autobidding\",\n  \"statusUpdatedBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"isAutoTrigger\": true,\n  \"targetRoas\": 15.25,\n  \"externalCampaignId\": \"<string>\",\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"bannerAdRejectionReason\": {\n    \"declineReason\": \"<string>\",\n    \"reasonDetails\": \"<string>\"\n  },\n  \"fallbackWalletId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"multiplierConfig\": {\n    \"isActive\": true,\n    \"multipliers\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\",\n        \"multiplier\": 0.5\n      }\n    ]\n  },\n  \"targetingFilters\": {\n    \"isActive\": true,\n    \"targetingFilters\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\"\n      }\n    ]\n  },\n  \"exclusionFilters\": {\n    \"isActive\": true,\n    \"exclusionFilters\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Bola-Bola Ad campaign\",\n  \"budget\": {\n    \"amount\": \"<unknown>\"\n  },\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"isActive\": true,\n  \"isSmart\": true,\n  \"campaignType\": \"autobidding\",\n  \"statusUpdatedBy\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"isAutoTrigger\": true,\n  \"targetRoas\": 15.25,\n  \"externalCampaignId\": \"<string>\",\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"bannerAdRejectionReason\": {\n    \"declineReason\": \"<string>\",\n    \"reasonDetails\": \"<string>\"\n  },\n  \"fallbackWalletId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"multiplierConfig\": {\n    \"isActive\": true,\n    \"multipliers\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\",\n        \"multiplier\": 0.5\n      }\n    ]\n  },\n  \"targetingFilters\": {\n    \"isActive\": true,\n    \"targetingFilters\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\"\n      }\n    ]\n  },\n  \"exclusionFilters\": {\n    \"isActive\": true,\n    \"exclusionFilters\": [\n      {\n        \"type\": \"user_segment\",\n        \"segmentId\": \"<string>\"\n      }\n    ]\n  }\n}"

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

{
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Bola-Bola Ad campaign",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "isActive": true,
  "isSmart": true,
  "campaignType": "manual",
  "status": "approved",
  "createdAt": "2023-11-07T05:31:56Z",
  "chargeType": "CPM",
  "externalVendorId": "<string>",
  "adFormat": "listing",
  "isAutoTrigger": true,
  "vendorId": "<string>",
  "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bidCount": 123,
  "budget": {
    "amount": 1000,
    "amountRemaining": 123,
    "amountCarryover": 123,
    "amountUsed": 123,
    "type": "daily"
  },
  "statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaignBehaviorData": "<string>",
  "campaignBehaviorDataByDay": "<string>",
  "exclusivityPrice": 123,
  "targetRoas": 123,
  "externalCampaignId": "<string>",
  "autobiddingObjective": "impressions",
  "mediaType": "video",
  "fallbackWalletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "multiplierConfig": {
    "isActive": true,
    "multipliers": [
      {
        "type": "user_segment",
        "segmentId": "<string>",
        "multiplier": 0.5
      }
    ]
  },
  "targetingFilters": {
    "isActive": true,
    "targetingFilters": [
      {
        "type": "user_segment",
        "segmentId": "<string>"
      }
    ]
  },
  "exclusionFilters": {
    "isActive": true,
    "exclusionFilters": [
      {
        "type": "user_segment",
        "segmentId": "<string>"
      }
    ]
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Autorisations

Authorization

string

header

requis

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Paramètres de chemin

campaign_id

string<uuid>

requis

The ID of the campaign.

Corps

application/json

Public Campaign Update Request Body.

name

string | null

The name of the campaign.

Minimum string length: 1

Exemple:

"Bola-Bola Ad campaign"

budget

BudgetUpdate · object | null

The budget of the campaign.

Show child attributes

startDate

string<date-time> | null

When should the campaign start. If the start date is in the past, it will be set to the current date.

endDate

string<date-time> | null

When should the campaign stop. Must be greater than start date.

isActive

boolean | null

Whether the campaign should be active/inactive.

isSmart

boolean | null

Whether the campaign is smart.

campaignType

enum<string> | null

The bidding type of the campaign. Can only be updated to autobidding.

Options disponibles:

autobidding

status

enum<string> | null

The approval status of the campaign, if it's a banner campaign.

Options disponibles:

approved,

pending,

rejected

statusUpdatedBy

string<uuid> | null

The ID of the user who approved the banner campaign.

isAutoTrigger

boolean | null

Whether the campaign is auto-triggered.

targetRoas

number | null

Indicates the vendor's goal. For banners, use autobiddingObjective instead. ROAS >12 is rare and depends on product metrics and attribution model.

Plage requise: 0.5 <= x <= 30

externalCampaignId

string | null

The external ID of the campaign in the marketplace. Must be unique per marketplace and format combination.

chargeType

enum<string> | null

How campaigns are going to be charged, by click, by per mille impressions, or by action.

Options disponibles:

CPM,

CPC,

CPA

autobiddingObjective

enum<string> | null

The objective of the campaign, only for autobidding campaigns.

Options disponibles:

impressions,

clicks,

conversions,

revenue

productIds

string[] | null

The product IDs to be used in the banner campaign. This is only allowed for banner campaigns. When provided, the assets will be associated to the given product IDs.

Required array length: 1 - 250 elements

bannerAdRejectionReason

BannerAdRejectionReason · object | null

Show child attributes

targetRoasPreference

enum<string> | null

Target ROAS preset (aggressive, moderate, conservative). When set, the numeric target ROAS is resolved from marketplace bidcalc configuration. Cannot be provided together with target_roas.

Options disponibles:

aggressive,

conservative,

moderate,

custom

fallbackWalletId

string<uuid> | null

The optional fallback wallet to be used with this campaign.

multiplierConfig

PublicCampaignMultiplierConfig · object | null

The multipliers of the campaign.

Show child attributes

targetingFilters

PublicCampaignTargetingFilters · object | null

The segments that the campaign will participate for (and will not for other segments not here).

Show child attributes

exclusionFilters

PublicCampaignExclusionFilters · object | null

The segments that the campaign will not target.

Show child attributes

Réponse

Successful Response

The campaign model.

campaignId

string<uuid>

requis

The ID of the campaign.

marketplaceId

string<uuid>

requis

The ID of the marketplace.

name

string

requis

The name of the campaign.

Minimum string length: 1

Exemple:

"Bola-Bola Ad campaign"

startDate

string<date-time>

requis

The starting date of the campaign.

endDate

string<date-time>

requis

The end date of the campaign.

isActive

boolean

requis

Whether this campaign is active.

isSmart

boolean

requis

Whether this campaign is "smart".

campaignType

enum<string>

requis

The bidding method for the campaign.

Options disponibles:

manual,

autobidding,

exclusive

status

enum<string>

requis

Represents the review status of a banner campaign.

Options disponibles:

approved,

pending,

rejected

createdAt

string<date-time>

requis

When was this campaign created.

chargeType

requis

Campaign charge type.

CPM: cost per mille impressions CPC: cost per click CPA: cost per action. CPA reflects the total cost to achieve a conversion.

Options disponibles:

CPM,

CPC,

CPA

externalVendorId

string

requis

obsolète

Deprecated since 2022-11-30. The ID of the vendor. Use vendor_id instead.

Minimum string length: 1

adFormat

enum<string>

requis

The ad format of the campaign. Can be listing or banner.

Options disponibles:

listing,

banner,

sponsored_brand,

exclusive_listing,

exclusive_banner,

travel_listing,

flight_listing

Exemple:

"listing"

isAutoTrigger

boolean

requis

Whether the campaign is auto-triggered.

vendorId

string

requis

The ID of the vendor.

Minimum string length: 1

walletId

string<uuid>

requis

The uuid of the wallet to be used with this campaign.

bidCount

integer

requis

obsolète

Deprecated since 2025-12-19. The amount of active bids associated with this campaign. This field will be set to 0 once the notice period is over.

budget

Budget · object | null

The budget assigned to the campaign.

Show child attributes

statusUpdatedBy

string<uuid> | null

The ID of the user who reviewed the campaign. If it's null and the status is not "pending" then it means this campaign has autoapproval status.

campaignBehaviorData

string | null

obsolète

Deprecated since 2023-08-31. This field is always null. For behavioral data use reporting service.

campaignBehaviorDataByDay

string | null

obsolète

Deprecated since 2023-08-31. This field is always null. For behavioral data use reporting service.

exclusivityPrice

integer | null

Daily price for an exclusive campaign, can only be set if a campaign is exclusive

targetRoas

number | null

The target return on ad spend (ROAS) for this campaign. This is only applicable for autobidding listing campaigns.

externalCampaignId

string | null

The external ID of the campaign in the marketplace. Must be unique per marketplace and format combination.

autobiddingObjective

enum<string> | null

The autobidding objective for the campaign.

Options disponibles:

impressions,

clicks,

conversions,

revenue

mediaType

enum<string> | null

Optional media type for banner campaigns. Set to video to allow the campaign to receive video events. Omit for standard image banners.

Options disponibles:

video

fallbackWalletId

string<uuid> | null

The optional fallback wallet to be used with this campaign.

multiplierConfig

PublicCampaignMultiplierConfig · object | null

The multiplier configuration for the campaign.

Show child attributes

targetingFilters

PublicCampaignTargetingFilters · object | null

The segments that the campaign will participate for (and will not for other segments not here).

Show child attributes

exclusionFilters

PublicCampaignExclusionFilters · object | null

The segments that the campaign will not target.

Show child attributes

Général

Exemples d'enchères

Exemples de webhooks

Auctions

Events

Toptimize

Toppie API

Campaign API

Catalog API

Billing API

Reporting API

Invitation API

User API

Webhooks API

Assets API

Segments Service

Offsite Ads API

Forecasting Service

Media API

Placement API

Export API

API Reference

Update Campaign By Id

Autorisations

Paramètres de chemin

Corps

Réponse