Documentation

update

Changes the advertiser parameters and the user settings for the advertiser's representative.

Any representative of an advertiser can edit the advertiser's parameters and their own personal settings.

The advertiser's chief representative can also edit the settings of another representative. To do this, pass the representative's username in the Client-Login request header.

Request

Note. 

The ClientInfo, Notification, and Phone parameters belong to the user who is a representative of the advertiser:

  • The user the request is made on behalf of, if the request is in the name of any representative of the advertiser and the HTTP Client-Login header is not included in the request.

  • The user whose username is specified in the HTTP Client-Login header, if the request is in the name of the advertiser's chief representative and the request includes the HTTP Client-Login header.

The Settings parameter is related to the advertiser, regardless of who the representative is.

Request structure in JSON format:

{
  "method": "update",
  "params": { 
    "Clients
[no-highlight[

Advertiser parameters and user settings to change.

Required

Yes

]no-highlight]
": [{ /* ClientUpdateItem */ "ClientInfo
[no-highlight[

First and last name of the Yandex.Direct user (no more than 255 characters).

Required

No

]no-highlight]
": (string), "Notification
[no-highlight[

The Yandex.Direct user‘s settings for SMS and email notifications.

Required

No

]no-highlight]
": { /* NotificationUpdate */ "Lang
[no-highlight[

Language for notifications.

Required

No

]no-highlight]
": ( "RU" | "UK" | "EN" | "TR" ), "Email
[no-highlight[

The email address for sending notifications related to the account (no more than 255 characters).

Required

No

]no-highlight]
": (string), "EmailSubscriptions
[no-highlight[

Types of notifications to send by email.

Required

No

]no-highlight]
": [{ /* EmailSubscriptionItem */ "Option
[no-highlight[

Type of notification:

  • RECEIVE_RECOMMENDATIONS — Yandex.Direct news and recommendations.

  • TRACK_MANAGED_CAMPAIGNS — Notifications for campaigns that have a personal manager.

  • TRACK_POSITION_CHANGES — Warnings about ads getting moved lower than the bid originally provided for.

Required

Yes

]no-highlight]
": ( "RECEIVE_RECOMMENDATIONS" | "TRACK_MANAGED_CAMPAIGNS" | "TRACK_POSITION_CHANGES" ), /* required */ "Value
[no-highlight[

Whether to send this type of notification.

Required

Yes

]no-highlight]
": ( "YES" | "NO" ) /* required */ }, ... ] }, "Phone
[no-highlight[

Phone number of the Yandex.Direct user (255 characters maximum).

Required

No

]no-highlight]
": (string), "Settings
[no-highlight[

Advertiser settings that only allow YES or NO values.

Required

No

]no-highlight]
": [{ /* ClientSettingUpdateItem */ "Option
[no-highlight[

Setting name:

  • CORRECT_TYPOS_AUTOMATICALLY — Automatically fix errors and typos.

  • DISPLAY_STORE_RATING — Add data from external sources to the ad (see Data from third parties in the Help for Yandex.Direct).

Required

Yes

]no-highlight]
": ( "CORRECT_TYPOS_AUTOMATICALLY" | "DISPLAY_STORE_RATING" ), /* required */ "Value
[no-highlight[

Setting value.

Required

Yes

]no-highlight]
": ( "YES" | "NO" ) /* required */ }, ... ] }] /* required */ } }
Parameter Type Description Required
params structure (for JSON) / UpdateRequest structure (for SOAP)
Clients array of ClientUpdateItemAdvertiser parameters and user settings to change.Yes
ClientUpdateItem structure
ClientInfo string

First and last name of the Yandex.Direct user (no more than 255 characters).

No
Notification NotificationUpdate

The Yandex.Direct user's settings for SMS and email notifications.

No
Phone string

Phone number of the Yandex.Direct user (255 characters maximum).

No
Settings array of ClientSettingUpdateItemAdvertiser settings that only allow YES or NO values.No
NotificationUpdate structure
Lang LangEnumLanguage for notifications.No
Email string

The email address for sending notifications related to the account (no more than 255 characters).

No
EmailSubscriptions array of EmailSubscriptionItemTypes of notifications to send by email.No
EmailSubscriptionItem structure
Option EmailSubscriptionEnum

Type of notification:

  • RECEIVE_RECOMMENDATIONS — Yandex.Direct news and recommendations.

  • TRACK_MANAGED_CAMPAIGNS — Notifications for campaigns that have a personal manager.

  • TRACK_POSITION_CHANGES — Warnings about ads getting moved lower than the bid originally provided for.

Yes
Value YesNoEnumWhether to send this type of notification.Yes
ClientSettingUpdateItem structure
Option ClientSettingUpdateEnum

Setting name:

  • CORRECT_TYPOS_AUTOMATICALLY — Automatically fix errors and typos.

  • DISPLAY_STORE_RATING — Add data from external sources to the ad (see Data from third parties in the Help for Yandex.Direct).

Yes
Value YesNoEnumSetting value.Yes

Response

Response structure in JSON format:

{
  "result": {  
    "UpdateResults
[no-highlight[

The result of changing advertiser parameters and user settings.

]no-highlight]
": [{ /* ClientsActionResult */ "ClientId
[no-highlight[

Advertiser ID. Returned if there are no errors; see the section Operations on object arrays.

]no-highlight]
": (long), "Warnings
[no-highlight[

Warnings that occurred during the operation.

]no-highlight]
": [{ /* ExceptionNotification */ "Code": (int), /* required */ "Message": (string), /* required */ "Details": (string) }, ... ], "Errors
[no-highlight[

Errors that occurred during the operation.

]no-highlight]
": [{ /* ExceptionNotification */ "Code": (int), /* required */ "Message": (string), /* required */ "Details": (string) }, ... ] }, ... ] /* required */ } }
Parameter Type Description
result structure (for JSON) / UpdateResponse structure (for SOAP)
UpdateResults array of ClientsActionResultThe result of changing advertiser parameters and user settings.
ClientsActionResult structure
ClientId longAdvertiser ID. Returned if there are no errors; see the section Operations on object arrays.
Warnings array of ExceptionNotification

Warnings that occurred during the operation.

Errors array of ExceptionNotification

Errors that occurred during the operation.