Campaign and line item statuses

Overview

This article describes the statuses for campaigns and line items.

Main endpoints

Method Endpoint Description Link
PATCH https://api.kaminoretail.dev/v2/campaigns/{campaign_id} Update campaign status. Patch a campaign
PATCH https://api.kaminoretail.dev/v2/line-items/{line_item_id} Update line item status. Patch a line item

A campaign inherits its status from its line items.

Campaign statuses

Status Description
Deleted The campaign is archived and cannot deliver anymore. All line items are in Deleted status.
Ended The campaign reached its end date. All line items are in Ended status.
Paused The campaign is paused, and ads aren't delivered. All line items are in Paused status.
Programming The campaign has no line items or all line items are in Programming status.
Review The campaign has finished line items and is awaiting retailer approval or rejection. All line items are in Review status.
Running The campaign is validated, and ads are delivered. At least one line item is in Running status. This is the only status in which the campaign delivers ads.
Scheduled The campaign has been validated and is awaiting live delivery. All line items are in Scheduled status.

Line item statuses

Status Description
Programming The line item exists without a creative part, that is, as a draft.
Review The line item is fully set up and is awaiting retailer approval.
Approved The retailer has validated the line item, and it can start delivering.
Rejected The retailer rejected the line item.
Running The line item is live, and ads are delivered on the website.
Paused The line item is paused, and ads aren't delivered on the website.
Scheduled The line item is scheduled for a future date range.
Ended The line item reached its end date.
Deleted The line item is deleted or archived.