Skip to main content

PUT Bidder

Overview


The following table contains important information about the PUT method in regards to updating a bidder.

PUT Bidder
MethodPUT
URL or Endpoint/api/projects/projectId/bidders
HeadersAuthorization
ParametersprojectId
BodyNot Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project

Request Body

{
"id":1007,
"name":"Bidder",
"notification":"",
"bidParamValues":
[
{
"id":9,
"name":"placementId",
"required":true,
"type":"string",
"placeholder":"placementId",
"bidderId":1007
}
]
}

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

Field NameTypeDescription
idinteger($int32)The id of the bidder.
namestringThe name of the bidder
notificationstringThe notification.
bidParamValuesarray[Object]Returns the bidder parameter values as an array of objects.
idinteger($int32)The id of the parameter value.
namestringThe name of the bidder parameter
requiredboolIndicates whether this parameter is required
typestringIndicates the type of the parameter
placeholderstringRepresents the name of placeholder.
bidderIdinteger($int32)The id of the bidder.

Response

{
"success": true,
"errors": [],
"messages": [
"Bidder with Id 1007 was updated!"
],
"result": {
"id": 1007,
"name": "Bidder",
"notification": "",
"bidParamValues": [
{
"id": 1011,
"name": "placementId",
"required": true,
"type": "string",
"placeholder": "placementId",
"bidderId": 1007
}
]
},
"resultInfo": null,
"statusCode": 200
}
Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
idinteger($int32)The id of the bidder.
namestringThe name of the bidder
notificationstringThe notification.
bidParamValuesarray[Object]Returns the bidder parameter values as an array of objects.
idinteger($int32)The id of the parameter value.
namestringThe name of the bidder parameter
requiredboolIndicates whether this parameter is required
typestringIndicates the type of the parameter
placeholderstringRepresents the name of placeholder.
bidderIdinteger($int32)The id of the bidder.
resultInfostringReturns extra information about the result.
statusCodeinteger($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: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed