Proposal Status Values for the REST API
This page lists the proposal status values in the Broadsign Direct REST API, as well as their corresponding values in the Broadsign Direct interface and in Broadsign Control.
For more information on the proposal status values in the Broadsign Direct interface, see The Proposal Status Menu and Proposals List Column Headings.
For more information on the proposal (campaign) status values in Broadsign Control, see the State column description in the Broadsign Control documentation.
The following table describes the various states in the Broadsign Direct interface and their corresponding values in the Broadsign Direct API and in Broadsign Control.
Broadsign Direct | Broadsign Control | Description | |
---|---|---|---|
Interface |
API | ||
Saved |
1 |
N/A |
Saved proposal in Broadsign Direct. |
Held |
4 |
N/A |
Held proposal in Broadsign Direct dictated by expiration timestamp. |
Partially Held |
5 |
N/A |
The proposal contains a mix of saved and held proposal items in Broadsign Direct. |
Submitted |
10 |
HELD (0) |
The proposal has been submitted to Broadsign Control. The campaign is created and has the Held status (before being Contracted in Broadsign Control). |
Booked |
11 |
CONTRACTED (1) |
Booked proposal in Broadsign Direct. The corresponding campaign is Promoted/Contracted in Broadsign Control, but not started yet. |
Live |
11 |
CONTRACTED (1) |
Live proposal in Broadsign Direct. The corresponding campaign is externally Promoted/Contracted in Broadsign Control, so it is playing. |
Cancelling |
15 |
N/A |
Waiting for Broadsign Control to confirm cancellation. |
Held Cancelled |
13 |
HELD_CANCELLED (3) |
Cancelled proposal in Broadsign Direct before being contracted externally. |