--- metadata: - name: generator content: Diplodoc Platform v5.52.0 alternate: - https://yandex.com/dev/direct/doc/en/agencyclients/update.md - https://yandex.com/dev/direct/doc/ru/agencyclients/update.md - href: ru/agencyclients/update.md type: text/markdown title: Markdown version - href: ../llms.txt type: text/markdown title: llms.txt sourcePath: ru/ref-v5/agencyclients/update.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/direct/doc/ru/llms.txt # update Изменяет параметры рекламодателей — клиентов агентства, а также настройки пользователей — главных представителей рекламодателя. {% note info %} В запросе к сервису `AgencyClients`: - В HTTP-заголовке `Authorization` укажите токен, полученный для представителя агентства. - HTTP-заголовок `Client-Login` не указывайте. {% endnote %} ## Узнайте больше - [Клиент (Client)](https://yandex.ru/dev/direct/doc/dg/objects/client.html) - [Роли и доступы пользователей Директа](https://yandex.ru/dev/direct/doc/dg/objects/roles.html) - [Как работает метод update](https://yandex.ru/dev/direct/doc/dg/best-practice/modify.html) - [Как обрабатывать ошибки](https://yandex.ru/dev/direct/doc/dg/concepts/errors.html) ## Ограничения {#restrictions} Не более 1000 клиентов в одном вызове метода. ## Запрос {#input} {% note info %} Параметры `ClientInfo`, `Notification`, `Phone` относятся к главному представителю рекламодателя (см. раздел [Роли и доступы пользователей Директа](https://yandex.ru/dev/direct/doc/dg/objects/roles.html)). Параметры `ClientId`, `Grants`, `Settings` относятся к рекламодателю. {% endnote %} Структура запроса в формате JSON: ```javascript translate=no { "method": "update", "params": { /* params */ "Clients": [{ /* AgencyClientUpdateItem */ "ClientId": (long), /* required */ "ClientInfo": (string), "Grants": [{ /* GrantItem */ "Privilege": ( "EDIT_CAMPAIGNS" | "IMPORT_XLS" | "TRANSFER_MONEY" ), /* required */ "Value": ( "YES" | "NO" ) /* required */ }, ... ], "Notification": { /* NotificationUpdate */ "Lang": ( "RU" | "UK" | "EN" | "TR" ), "Email": (string), "EmailSubscriptions": [{ /* EmailSubscriptionItem */ "Option": ( "RECEIVE_RECOMMENDATIONS" | "TRACK_MANAGED_CAMPAIGNS" | "TRACK_POSITION_CHANGES" ), /* required */ "Value": ( "YES" | "NO" ) /* required */ }, ... ] }, "Phone": (string), "Settings": [{ /* ClientSettingUpdateItem */ "Option": ( "DISPLAY_STORE_RATING" | "CORRECT_TYPOS_AUTOMATICALLY" ), /* required */ "Value": ( "YES" | "NO" ) /* required */ }, ... ], "TinInfo" : { /* TinInfoUpdate */ "TinType" : ( "PHYSICAL" | "FOREIGN_PHYSICAL" | "LEGAL" | "FOREIGN_LEGAL" | "INDIVIDUAL" ), "Tin" : (string) /* nillable */ }, /* nillable */ "ErirAttributes": { /* ErirAttributesUpdate */ "Organization": { /* OrganizationUpdate */ "Name": (string), /* nillable */ "Kpp": (string), /* nillable */ "EpayNumber": (string), /* nillable */ "RegNumber": (string), /* nillable */ "OksmNumber": (string), /* nillable */ "OkvedCode": (string) /* nillable */ }, /* nillable */ "Contract": { /* ContractUpdate */ "Number": (string), /* nillable */ "Date": (string), /* nillable */ "Type": ( "CONTRACT" | "INTERMEDIARY_CONTRACT" | "ADDITIONAL_AGREEMENT" ), /* nillable */ "ActionType": ( "COMMERCIAL" | "DISTRIBUTION" | "CONCLUDE" | "OTHER" ), /* nillable */ "SubjectType": ( "REPRESENTATION" | "MEDIATION" | "DISTRIBUTION" | "ORG_DISTRIBUTION" | "OTHER" ), /* nillable */ "Price": { /* PriceUpdate */ "Amount": (decimal), /* required */ "IncludingVat": ( "YES" | "NO" ) /* required */ } /* nillable */ }, /* nillable */ "Contragent": { /* ContragentUpdate */ "Name": (string), /* nillable */ "Kpp": (string), /* nillable */ "Phone": (string), /* nillable */ "EpayNumber": (string), /* nillable */ "RegNumber": (string), /* nillable */ "OksmNumber": (string), /* nillable */ "TinInfo": { /* TinInfoUpdate */ "TinType": ( "PHYSICAL" | "FOREIGN_PHYSICAL" | "LEGAL" | "FOREIGN_LEGAL" | "INDIVIDUAL" ), "Tin": (string) /* nillable */ } /* nillable */ } /* nillable */ } /* nillable */ }] /* required */ } } ``` #| || **Параметр** | **Тип** | **Описание** | **Обязательный** || || **Структура params (для JSON) / UpdateRequest (для SOAP)** | > | > | > || || `Clients` | array of AgencyClientUpdateItem | Параметры рекламодателей — клиентов агентства и настройки пользователей — главных представителей рекламодателя, которые требуется изменить. | Да || || **Структура AgencyClientUpdateItem** | > | > | > || || `ClientId` | long | Идентификатор рекламодателя. | Да || || `ClientInfo` | string | Название клиента (до 255 символов). | Нет || || `Grants` | array of GrantItem | Полномочия рекламодателя по управлению кампаниями. | Нет || || `Notification` | NotificationUpdate | Настройки SMS- и email-уведомлений пользователя Директа. | Нет || || `Phone` | string | Номер телефона пользователя Директа (до 50 символов, содержит только цифры и должен начинаться с кода страны). | Нет || || `Settings` | array of ClientSettingUpdateItem | Настройки рекламодателя, допускающие только значения YES или NO. | Нет || || `TinInfo` | TinInfoUpdate | Налоговые данные конечного рекламодателя. | Нет || || `ErirAttributes` | ErirAttributesUpdate | Дополнительные данные рекламодателя для маркировки рекламы. | Нет || || **Структура GrantItem** | > | > | > || || `Privilege` | PrivilegeEnum | Имя полномочия: - EDIT_CAMPAIGNS — редактирование кампаний. - IMPORT_XLS — управление кампаниями с помощью файлов (см. раздел [Управление кампаниями с помощью файлов формата XLS и XLSX](https://yandex.ru/support/direct/alternative-interfaces/xls-interface.html) Справки Директа). Для полномочия IMPORT_XLS можно указать значение YES только при условии, что для полномочия EDIT_CAMPAIGNS установлено значение YES, в противном случае возвращается ошибка. Для полномочия EDIT_CAMPAIGNS можно указать значение NO только при условии, что для полномочия IMPORT_XLS установлено значение NO, в противном случае возвращается ошибка. | Да || || `Value` | YesNoEnum | Есть ли у клиента данное полномочие. | Да || || **Структура NotificationUpdate** | > | > | > || || `Lang` | LangEnum | Язык уведомлений. | Нет || || `Email` | string | Адрес электронной почты для отправки уведомлений, связанных с аккаунтом (до 255 символов). | Нет || || `EmailSubscriptions` | array of EmailSubscriptionItem | Типы уведомлений, отправляемых по электронной почте. | Нет || || **Структура EmailSubscriptionItem** | > | > | > || || `Option` | EmailSubscriptionEnum | Тип уведомления: - RECEIVE_RECOMMENDATIONS — новости Директа и рекомендации. - TRACK_MANAGED_CAMPAIGNS — уведомления по кампаниям, обслуживаемым персональным менеджером. - TRACK_POSITION_CHANGES — предупреждения о снижении прогноза трафика относительно того, который обеспечивали ставки на момент установки. | Да || || `Value` | YesNoEnum | Отправлять ли уведомления данного типа. | Да || || **Структура ClientSettingUpdateItem** | > | > | > || || `Option` | ClientSettingUpdateEnum | Имя настройки: - CORRECT_TYPOS_AUTOMATICALLY — автоматически исправлять ошибки и опечатки. - DISPLAY_STORE_RATING — дополнять объявления данными из внешних источников (см. раздел [Данные из внешних источников](https://yandex.ru/support/direct/efficiency/enrich-ads-with-third-party-data.html) Справки Директа). | Да || || `Value` | YesNoEnum | Значение настройки. | Да || || **Структура TinInfoUpdate** | > | > | > || || `TinType` | TinTypeEnum | Тип организации: - LEGAL — юридическое лицо; - PHYSICAL — физическое лицо; - INDIVIDUAL — индивидуальный предприниматель; - FOREIGN_LEGAL — иностранное юридическое лицо; - FOREIGN_PHYSICAL — иностранное физическое лицо. | Нет || || `Tin` | string | Номер налогоплательщика либо его аналог в стране регистрации. | Нет || || **Структура ErirAttributesUpdate** | > | > | > || || `Organization` | OrganizationUpdate | Информация об организации конечного рекламодателя. | Нет || || `Contract` | ContractUpdate | Информация о договоре клиента-контрагента с конечным рекламодателем. | Нет || || `Contragent` | ContragentUpdate | Информация о контрагенте конечного рекламодателя. | Нет || || **Структура OrganizationUpdate** | > | > | > || || `Name` | string | Наименование организации (до 255 символов). | Нет || || `Kpp` | string | КПП организации (до 255 символов). || || `EpayNumber` | string | Номер электронного средства платежа (от 3 до 255 латинских символов, без пробелов в начале и в конце, пробелы посередине должны сохраняться). | Нет || || `RegNumber` | string | Регистрационный номер либо его аналог (до 255 символов). | Нет || || `OksmNumber` | string | Код страны регистрации юрлица в соответствии с ОКСМ (до 3 символов, содержит только цифры). | Нет || || `OkvedCode` | string | Код вида деятельности по ОКВЭД. | Нет || || **Структура ContractUpdate** | > | > | > || || `Number` | string | Номер договора (до 255 символов). | Нет || || `Date` | string | Дата договора в формате YYYY-MM-DD (не раньше 01.01.1991). | Нет || || `Type` | ContractTypeEnum | Тип договора: - CONTRACT — договор оказания услуг; - INTERMEDIARY_CONTRACT — посреднический договор; - ADDITIONAL_AGREEMENT — дополнительное соглашение. | Нет || || `ActionType` | ContractActionTypeEnum | Тип осуществляемых посредником-представителем действий: - COMMERCIAL — коммерческое представительство; - DISTRIBUTION — действия в целях распространения рекламы; - CONCLUDE — заключение договоров; - OTHER — иное. | Нет || || `SubjectType` | ContractSubjectTypeEnum | Предмет договора: - REPRESENTATION — представительство; - MEDIATION — посредничество; - DISTRIBUTION — договор на распространение рекламы; - ORG_DISTRIBUTION — договор на организацию распространения рекламы; - OTHER — иное. | Нет || || `Price` | ContractPrice | Цена договора (не более двух знаков после разделителя). | Нет || || **Структура ContractPrice** | > | > | > || || `Amount` | decimal | Стоимость договора. | Да || || `IncludingVat` | YesNoEnum | Включен ли в стоимость НДС. | Да || || **Структура ContragentUpdate** | > | > | > || || `Name` | string | Наименование (до 255 символов). | Нет || || `Kpp` | string | КПП организации (до 255 символов). || || `Phone` | string | Номер телефона (до 50 символов, содержит только цифры и должен начинаться с кода страны). | Нет || || `EpayNumber` | string | Номер электронного средства платежа (от 3 до 255 латинских символов, без пробелов в начале и в конце, пробелы посередине должны сохраняться). | Нет || || `RegNumber` | string | Регистрационный номер либо его аналог (до 255 символов). | Нет || || `OksmNumber` | string | Код страны регистрации юрлица в соответствии с ОКСМ (до 3 символов, содержит только цифры). | Нет || || `TinInfo` | TinInfoUpdate | Налоговые данные контрагента. | Нет || |# ## Ответ {#output} Структура ответа в формате JSON: ```javascript translate=no { "result": { /* result */ "UpdateResults": [{ /* ClientsActionResult */ "ClientId": (long), "Warnings": [{ /* ExceptionNotification */ "Code": (int), /* required */ "Message": (string), /* required */ "Details": (string) }, ... ], "Errors": [{ /* ExceptionNotification */ "Code": (int), /* required */ "Message": (string), /* required */ "Details": (string) }, ... ] }, ... ] /* required */ } } ``` #| || **Параметр** | **Тип** | **Описание** || || **Структура result (для JSON) / UpdateResponse (для SOAP)** | > | > || || `UpdateResults` | array of ClientsActionResult | Результат изменения параметров рекламодателей — клиентов агентства, а также настроек пользователей — главных представителей рекламодателя. || || **Структура ClientsActionResult** | > | > || || `ClientId` | long | Идентификатор рекламодателя. Возвращается в случае отсутствия ошибок, см. раздел [Операции над массивом объектов](https://yandex.ru/dev/direct/doc/dg/best-practice/modify.html). || || `Warnings` | array of ExceptionNotification | Предупреждения, возникшие при выполнении операции. || || `Errors` | array of ExceptionNotification | Ошибки, возникшие при выполнении операции. || |#