Skip to main content
POST
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
campaign_optimizations
/
{id}
/
restart
Restart campaign optimization pipeline
curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/campaign_optimizations/{id}/restart \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "platform_integration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign": "<unknown>",
  "name": "<string>",
  "analysis": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string<uuid>
required

A UUID string identifying the campaign optimization.

​
organization_id
string
required
​
workspace_id
string<uuid>
required

Query Parameters

​
format
enum<string>
Available options:
csv,
json

Body

​
workspace_id
string<uuid>
required
​
platform_integration_id
string<uuid>
required
​
platform
enum<string>
required
  • google_ads - google ads
  • tiktok - tiktok
Available options:
google_ads,
tiktok
​
campaign
any
required
​
name
string
required
Maximum string length: 255
​
analysis
string<uuid>
required
​
status
enum<string>
  • pending - pending
  • in_progress - in progress
  • completed - completed
  • failed - failed
  • suggestions_applied - suggestions applied
Available options:
pending,
in_progress,
completed,
failed,
suggestions_applied
​
language
enum<string>
  • ar - ar
  • da - da
  • de - de
  • en - en
  • es - es
  • eu - eu
  • fi - fi
  • fil - fil
  • fr - fr
  • he - he
  • hi - hi
  • hu - hu
  • id - id
  • it - it
  • ja - ja
  • ko - ko
  • nl - nl
  • pl - pl
  • pt - pt
  • ro - ro
  • sv - sv
  • th - th
  • tr - tr
  • ur - ur
  • vi - vi
  • zh - zh
  • zh-TW - zh TW
Available options:
ar,
da,
de,
en,
es,
eu,
fi,
fil,
fr,
he,
hi,
hu,
id,
it,
ja,
ko,
nl,
pl,
pt,
ro,
sv,
th,
tr,
ur,
vi,
zh,
zh-TW,

Response

Pipeline restart triggered successfully.