POST Bidding Template

Overview

---

The following table contains important information about the POST method in regards to posting a bidding template.

POST Bidding Template
Method	POST
URL or Endpoint	/api/projects/projectId/bidding-templates
Headers	Authorization
Parameters	projectId
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project

Request Body

{
  "name": "Mall Bidder Update ",
  "mediationOptionId": 1,
  "biddingTemplateBidders": [
    {
      "bidderId": 2,
      "bidParamValues": [
        {
          "bidParamId": 16,
          "value": "string"
        }
      ]
    }
  ]
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
name	string	The name of the bidding template
mediaOptionId	integer($int32)	The id of the media option.
bidderId	integer($int32)	The id of the bidder.
bidParamValues	array[Object]	Returns the bidder parameter values as an array of objects.
bidParamId	integer($int32)	The id of the bidder parameter value.
value	string	The value of the bidder parameter.

Response

{
  "success":true,
  "errors":[],
  "messages":[ 
      "Bidding Template with id bqevmvts was added!"
  ],
  "result":
  {
    "name":"Mall Bidder Update ",
    "publicId":"bqevmvts",
    "mediationOptionId":1,
    "biddingTemplateBidders":
    [
      {
        "id":41,
        "biddingTemplatePublicId":"bqevmvts",
        "bidderId":2,
        "name":"MallTv",
        "bidParamValues":
        [
          {
            "id":16,
            "biddingTemplateBidderId":41,
            "bidParamId":16,
            "value":"asddsa"
          },
          {
            "id":17,
            "biddingTemplateBidderId":41,
            "bidParamId":17,
            "value":"asddsa"
          }
        ]
      }
    ]
  },
  "resultInfo":null,
  "statusCode":200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
name	string	The name of the bidding template
publicId	string	The id of the bidder.
mediaOptionId	integer($int32)	The id of the media option.
biddingTemplateBidders	array[Object]	Returns the bidding template bidders as an array of objects.
id	integer($int32)	The id of the bidder.
biddingTemplatePublicId	string	The id of the bidder.
bidderId	integer($int32)	The id of the bidder.
name	string	The name of the bidder
bidParamValues	array[Object]	Returns the bidder parameter values as an array of objects.
id	integer($int32)	The id of the bidder parameter value.
biddingTemplateBidderId	integer($int32)	The id of the bidding template bidder.
bidParamId	integer($int32)	The id of the bidder parameter value.
value	string	The value of the bidder parameter.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: If the service is down