Skip to content
Kumquat
Esc
↑↓navigate↵open⌘Jpreview

Mark Packs Launched

Report the packs a platform put live, by Kumquat id or by pack name: each gets its launched_at stamped, its test started, and the same instant — and the same ad_id, when the call carries one — written onto every creative the feed offered under it: the cards with a file to upload.

The pack-level counterpart of /creatives/launched, for the platform that launches a whole campaign at once rather than card by card. Where the two disagree the pack wins: a creative someone reported on its own is restamped with the pack’s instant, because a pack’s ads go live together.

Never a 404 — a batch is reported as a whole, so a pack Kumquat cannot act on carries its own status in its own row while the rest are recorded: not_found, not_launchable for a pack that has not finished, and ambiguous for a name matching more than one live pack (they are not unique — report that one by id). Replays are safe: a pack that already carries a launched_at keeps it, comes back already_launched, and its creatives are left alone apart from the ad_id, which the pack and its creatives take from the call if it carries one.

POST/api/v1/integrations/creative-tests/packs/launched
Authorization
AuthorizationBearer token · headerrequired
Static token issued to an integrating platform (INTEGRATIONS__TOKENS)
Request body
requiredapplication/json
packsLaunchedPack[]required
min items 1 · max items 100
Show properties
Array of LaunchedPack
idstring | any
Show properties
Any of:
string
string
any
any
namestring | any
Show properties
Any of:
string
string
any
any
launched_atstring<date-time> | any
when the pack went live; defaults to the time this call is served
Show properties
Any of:
string<date-time>
string<date-time>
any
any
ad_idstring | any
the ad account's id for the campaign this pack went live as. Written onto the pack and onto every creative the launch reached, and recorded once, the same way `launched_at` is.
Show properties
Any of:
string
string
any
any
Responses
200Successful Response
Array of LaunchedPackResult
idstring | any
Show properties
Any of:
string
string
any
any
namestring | any
Show properties
Any of:
string
string
any
any
statusPackLaunchOutcomerequired
What `mark_pack_launched` did — the launching platform gets one of these per pack it named. Wider than the creative-level `LaunchOutcome` because a pack can be named in ways a creative cannot: its name is not unique, and it has a workflow status that says whether it was ever handed out to be launched at all.
Allowed:launchedalready_launchednot_foundambiguousnot_launchable
launched_atstring<date-time> | any
Show properties
Any of:
string<date-time>
string<date-time>
any
any
test_statusTestStatus | any
Show properties
Any of:
TestStatus
string
any
any
ad_idstring | any
Show properties
Any of:
string
string
any
any
creativesLaunchedResult[]
the cards this call stamped; empty unless `status` is `launched`
Show properties
Array of LaunchedResult
idstring | any
Show properties
Any of:
string
string
any
any
namestring | any
Show properties
Any of:
string
string
any
any
statusLaunchOutcomerequired
What `mark_launched` did — the launching platform gets one of these per creative it named.
Allowed:launchedalready_launchednot_found
launched_atstring<date-time> | any
Show properties
Any of:
string<date-time>
string<date-time>
any
any
test_statusTestStatus | any
Show properties
Any of:
TestStatus
string
any
any
ad_idstring | any
Show properties
Any of:
string
string
any
any
422Validation Error
detailValidationError[]
Show properties
Array of ValidationError
locstring | integer[]required
Show properties
Array of string | integer
Any of:
string
string
integer
integer
msgstringrequired
typestringrequired
inputany
ctxobject
Request
curl -X POST "/api/v1/integrations/creative-tests/packs/launched" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "packs": [
    {
      "id": "string",
      "name": "string",
      "launched_at": "2019-08-24T14:15:22Z",
      "ad_id": "string"
    }
  ]
}'
Response
[
  {
    "id": "string",
    "name": "string",
    "status": "launched",
    "launched_at": "2019-08-24T14:15:22Z",
    "test_status": "not_tested",
    "ad_id": "string",
    "creatives": [
      {
        "id": "string",
        "name": "string",
        "status": "launched",
        "launched_at": "2019-08-24T14:15:22Z",
        "test_status": "not_tested",
        "ad_id": "string"
      }
    ]
  }
]