Amend a Proposal Item with the API

This example illustrates how to amend a held, submitted, booked, or live proposal item by using the Broadsign Direct REST API.

When amending proposal items, you can perform the following modifications:

  • Modify the name of the proposal item.
  • Modify the start date (except for live proposal items).
  • Modify the end date.
  • Add or remove screens.

The Broadsign Direct REST API endpoints and parameters are described in the REST Method Reference.

Note: The ID#s we use in these samples are for illustration purposes. They are invalid. Be sure to use your own ID#s for your integrations.

Note: All request body examples in this document are raw JSONs.

You will need to use the following methods to amend a proposal item.

Note that you will need the ID#s from the responses as values for parameters in the next steps in sequence:

  1. Check the availability of a proposal item that you want to amend. Use the /api/v1/proposal/proposal_item/{proposal_item_id}/amend/availability POST method.
  2. Amend the proposal item. Use the /api/v1/proposal/proposal_item/{proposal_item_id}/amend POST method.

Request Method: POST

Request URL: https://direct.broadsign.com/api/v1/proposal/proposal_item/{proposal_item_id}/amend/ availability

Check the availability of a proposal item that you want to amend.

You will need the ID of the specific proposal item to amend.

Request

You can send the whole list of screens in the screens_ids parameter. Broadsign Direct will do the delta, adding the missing screens and removing the non-specified screens.

Copy 
{
 "start_date": "2021-12-16",
 "end_date": "2021-12-19",
 "screen_ids": [
   53996, 
   54005,
   54006,
   54007,
   54009,
   54018
 ],
 "name": "Proposal Item - New Name"
}

Response

Copy 
{
   "proposal_id": 302748,
   "proposal_name": "test",
   "availability": "available",
   "goals": [],
   "proposal_items": [
       {
           "proposal_item_id": 421330,
           "proposal_item_name": "test",
           "availability": "available",
           "inventory_type": "digital",
           "is_package": false,
           "screens": {
               "available": {
                   "screen_ids": [
                       54018,
                       54005,
                       54006,
                       54007,
                       54009,
                       53996
                   ],
                   "messages": [],
                   "screen_count": 6
               }
           },
           "messages": [],
           "amend_start_date": "2022-12-16",
           "amend_end_date": "2022-12-19"
       }
   ],
   "requested_screen_count": 6,
   "bookable_screen_count": 6
}

Request Method: POST

Request URL: https://direct.broadsign.com/api/v1/proposal/proposal_item/{proposal_item_id}/amend

Amend the proposal item.

When amending proposal items, you can perform the following modifications:

  • Modify the name of the proposal item.
  • Modify the start date (except for live proposal items).
  • Modify the end date.
  • Add or remove screens.

You will need the ID of the specific proposal item to amend.

Request

You can send the whole list of screens in the screens_ids parameter. Broadsign Direct will do the delta, adding the missing screens and removing the non-specified screens.

Copy 
{
 "start_date": "2021-12-16",
 "end_date": "2021-12-19",
 "screen_ids": [
   53996,
   54005,
   54006,
   54007,
   54009,
   54018
 ],
 "name": "Proposal Item - New Name"
}

Response

You must get a 200 Success response.