PUT Ad Function

Overview

---

The following table contains important information about the PUT method in regards to putting an ad function.

PUT Update Ad Function
Method	PUT
URL or Endpoint	/api/projects/projectId/ad-functions
Headers	Authorization
Parameters	projectId, api-version
Body	Check the request body below.

The description of the URL parameter is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	No	string	Unique id of the project.
api-version	No	string	The correct api version to use.

Request Body

{
  "id": 0,
  "name": "string",
  "key": "string",
  "dynamicKey": true,
  "dynamicValue": true,
  "value": "string"
}

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

Parameter Name	Mandatory	Type	Description
id	Yes	string	The id of the ad function.
name	Yes	string	The name of the ad function.
key	Yes	string	The key of the ad function.
dynamicKey	Yes	bool	Indicates whether the ad function contains a dynamic key or not.
dynamicValue	Yes	bool	Indicates whether the ad function contains a dynamic value or not.
value	Yes	string	The value of the ad function.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": {
    "id": 0,
    "name": "string",
    "key": "string",
    "dynamicKey": true,
    "dynamicValue": true,
    "value": "string"
  },
  "resultInfo": "string",
  "statusCode": 0
}

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.
id	integer	The id of the ad function.
name	Yes	string	The name of the ad function.
key	Yes	string	The key of the ad function.
dynamicKey	Yes	bool	Indicates whether the ad function contains a dynamic key or not.
dynamicValue	Yes	bool	Indicates whether the ad function contains a dynamic value or not.
value	Yes	string	The value of the ad function.
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: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed