modify

Edit a banner type.

Request format

https://adfox.yandex.com/api/v1
  ? object=bannerType
  & action=modify
  & objectID=<integer>
  & [name=<string>]
  & [isOn=<integer>]
  & [width=<string>]
  & [height=<string>]

objectID*

ID of the object the action applies to.

name

Object name.

An entry can contain Russian and Latin letters, numbers, and any special characters

isOn

Enable/disable the object.

Acceptable values:

  • 0: disabled.
  • 1: enabled.

width

Width in pixels. Specified for banner types:

  • Standard.
  • Nondimensional: For system templates.

Acceptable values: Integers from 1 to 2147483647.

height

Height in pixels. Specified for banner types:

  • Standard.
  • Nondimensional: For system templates.

Acceptable values: Integers from 1 to 2147483647.

Response format

<response>
  <status>
    <code>{integer}</code>
  </status>
</response>

Response parameters

code

Request processing status. A value of 0 means the request was completed successfully. For the key, see Error handling.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=bannerType&action=modify&objectID=543&name=240х400

Response:

<response>
  <status>
    <code>0</code>
  </status>
</response>

Other actions with the object

Read about other actions with the bannerType object:

ID of the object the action applies to.

Object name.

An entry can contain Russian and Latin letters, numbers, and any special characters

Enable/disable the object.

Acceptable values:

  • 0: disabled.
  • 1: enabled.

Width in pixels. Specified for banner types:

  • Standard.
  • Nondimensional: For system templates.

Acceptable values: Integers from 1 to 2147483647.

Height in pixels. Specified for banner types:

  • Standard.
  • Nondimensional: For system templates.

Acceptable values: Integers from 1 to 2147483647.

Required parameter.

Previous
template
Next
updateDefaultBanner