Request For Proposal API For Suppliers¶

Request For Proposal API allows Suppliers to receive preferred inventory requests from connected Buyer partners, to view existing requests, to respond with IDs of deals that fit the partner’s requirements.

To connect to Request For Proposal API, use the following steps.

Create an API user in your myBidSwitch UI account.
Using this user’s credentials, get your API token by making a POST request to the BidSwitch authorization endpoint.
Pass this token in your request header Authorization:Bearer ${TOKEN}

To view all existing requests for proposal, GET the following endpoint:

api/v1/ssp/<ssp-id>/rfp/

To sort the list of requests by the date of update in descending order, GET the following endpoint:

api/v1/ssp/<ssp-id>/rfp/<rfp-id>/

To search for a request by its name, GET the following endpoint:

api/v1/ssp/1/rfp/?query=rfp-name

Existing requests can be filtered by status, GET the following endpoint:

api/v1/ssp/1/rfp/?status=requested

To get details of a particular request, GET the following endpoint:

api/v1/ssp/<ssp-id>/rfp/<rfp-id>/

Updating Request Status¶

To update request status or the ID of a deal, PATCH the following endpoint:

/api/v1/ssp/255/dsp_rfp_ssp/{id}/

The {id} is the ID of an existing Deals Sync deal.

Only the request status and the deal ID can be updated on the Supplier side.

See the PATCH request example below.

Updating Deal ID And Request Status¶

{
  "status": "resolved",
  "deal": {
    "id": 1,
  },
}

A request can have the following statuses:

requested: for requests created by a Buyer and not yet reviewed by a Supplier; can only be set by Buyer
canceled: for requests canceled by a Buyer, a canceled request can be updated; can only be set by Buyer
resolved: status set by the Supplier after the Buyer accepts the deal; can only be set by Supplier

Request For Proposal API Fields¶

Request For Proposal API is represented by the following fields.

Optional fields are marked with *.

Field	Type	Description
id	integer	The unique ID of the request
status	string	The status of the request
status_was_changed_by_side*	string	Set automatically within the partners’ action (creating, updating), can be `dsp` or `ssp`
dsp_rfp_id	integer
ssp_id	int	The ID of a targeted SSP
ds_deal_id*	integer	The unique ID of a Deal Sync deal; one deal can be linked to multiple requests
bidstream_deal_id*	string	Bidstream deal ID
updated*	string	The date and time of the latest update of the request
ssp_note*	string	A note added by Supplier when accepting the request
rejection_reason*	string	The reason why Supplier rejected the request