update
Changes the parameters of advertisers who are agency clients, and user settings for chief representatives of advertisers.
- In the Authorization header, specify the access token you received for the agency representative.
- Don't specify the Client-Login header.
Restrictions
Maximum of 1000 clients per method call.
Request
Request structure in JSON format:
{
"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 */
"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 */
"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 */
}
}
Parameter | Type | Description | Required |
Params structure (for JSON) / UpdateRequest structure (for SOAP) | |||
---|---|---|---|
Clients | array of AgencyClientUpdateItem | The parameters (for agency client advertisers) and user settings (for chief representatives of advertisers) that you need to change. | Yes |
AgencyClientUpdateItem structure | |||
ClientId | long | Advertiser ID. | Yes |
ClientInfo | string | Client name (maximum of 255 characters). | No |
Grants | array of GrantItem | The advertiser's permissions for campaign management. | No |
Notification | NotificationUpdate | The Yandex Direct user's settings for SMS and email notifications. | No |
Phone | string | Phone number of the Yandex Direct user (50 characters maximum, only numbers allowed, starting with the country code). | No |
Settings | array of ClientSettingUpdateItem | Advertiser settings that only allow YES or NO values. | No |
TinInfo | TinInfoUpdate | Tax data of the end-advertiser. | No |
ErirAttributes | ErirAttributesUpdate | Additional advertiser data to label ads with. | No |
GrantItem structure | |||
Privilege | PrivilegeEnum | Name of the permission:
For the IMPORT_XLS permission, you can only set the YES value if the EDIT_CAMPAIGNS permission is also set to YES. Otherwise, an error is returned. For the EDIT_CAMPAIGNS permission, you can only set the NO value if the IMPORT_XLS permission is set to NO. Otherwise, an error is returned. | Yes |
Value | YesNoEnum | Whether the client has this permission. | Yes |
NotificationUpdate structure | |||
Lang | LangEnum | Language for notifications. | No |
Email | string | The email address for sending notifications related to the account (no more than 255 characters). | No |
EmailSubscriptions | array of EmailSubscriptionItem | Types of notifications to send by email. | No |
EmailSubscriptionItem structure | |||
Option | EmailSubscriptionEnum | Type of notification:
| Yes |
Value | YesNoEnum | Whether to send this type of notification. | Yes |
ClientSettingUpdateItem structure | |||
Option | ClientSettingUpdateEnum | Setting name:
| Yes |
Value | YesNoEnum | Setting value. | Yes |
TinInfoUpdate structure | |||
TinType | TinTypeEnum | Organization type:
| No |
Tin | string | The taxpayer number or its equivalent in the country of registration. | No |
ErirAttributesUpdate structure | |||
Organization | OrganizationUpdate | Details about the organization of the end-advertiser. | No |
Contract | ContractUpdate | Details of the contract of the client counterparty with the end-advertiser. | No |
Contragent | ContragentUpdate | Information about the counterparty of the end-advertiser. | No |
OrganizationUpdate structure | |||
Name | string | Organization name (up to 255 characters). | No |
EpayNumber | string | The number of the electronic payment instrument (up to 255 characters). | No |
RegNumber | string | Registration number or its equivalent (up to 255 characters). | No |
OksmNumber | string | Legal entity's code of the country of registration according to OKSM (up to 3 characters, numbers only). | No |
OkvedCode | string | Business category code according to OKVED. | No |
ContractUpdate structure | |||
Number | string | Contract number (up to 255 characters). | No |
Date | string | Contract date in YYYY-MM-DD format (no earlier than January 01, 1991). | No |
Type | ContractTypeEnum | Type of contract:
| No |
ActionType | ContractActionTypeEnum | Types of activities of the intermediary representative:
| No |
SubjectType | ContractSubjectTypeEnum | Contract subject:
| No |
Price | ContractPrice | Contract price (no more than two decimal digits allowed). | No |
ContractPrice structure | |||
Amount | decimal | The value of the contract. | Yes |
IncludingVat | YesNoEnum | Whether VAT is included in the contract value. | Yes |
ContragentUpdate structure | |||
Name | string | Name (up to 255 characters). | No |
Phone | string | Phone number (50 characters maximum, only numbers allowed, starting with the country code). | No |
EpayNumber | string | The number of the electronic payment instrument (up to 255 characters). | No |
RegNumber | string | Registration number or its equivalent (up to 255 characters). | No |
OksmNumber | string | Legal entity's code of the country of registration according to OKSM (up to 3 characters, numbers only). | No |
TinInfo | TinInfoUpdate | Tax details of the counterparty. | No |
Parameter | Type | Description | Required |
Params structure (for JSON) / UpdateRequest structure (for SOAP) | |||
---|---|---|---|
Clients | array of AgencyClientUpdateItem | The parameters (for agency client advertisers) and user settings (for chief representatives of advertisers) that you need to change. | Yes |
AgencyClientUpdateItem structure | |||
ClientId | long | Advertiser ID. | Yes |
ClientInfo | string | Client name (maximum of 255 characters). | No |
Grants | array of GrantItem | The advertiser's permissions for campaign management. | No |
Notification | NotificationUpdate | The Yandex Direct user's settings for SMS and email notifications. | No |
Phone | string | Phone number of the Yandex Direct user (50 characters maximum, only numbers allowed, starting with the country code). | No |
Settings | array of ClientSettingUpdateItem | Advertiser settings that only allow YES or NO values. | No |
TinInfo | TinInfoUpdate | Tax data of the end-advertiser. | No |
ErirAttributes | ErirAttributesUpdate | Additional advertiser data to label ads with. | No |
GrantItem structure | |||
Privilege | PrivilegeEnum | Name of the permission:
For the IMPORT_XLS permission, you can only set the YES value if the EDIT_CAMPAIGNS permission is also set to YES. Otherwise, an error is returned. For the EDIT_CAMPAIGNS permission, you can only set the NO value if the IMPORT_XLS permission is set to NO. Otherwise, an error is returned. | Yes |
Value | YesNoEnum | Whether the client has this permission. | Yes |
NotificationUpdate structure | |||
Lang | LangEnum | Language for notifications. | No |
Email | string | The email address for sending notifications related to the account (no more than 255 characters). | No |
EmailSubscriptions | array of EmailSubscriptionItem | Types of notifications to send by email. | No |
EmailSubscriptionItem structure | |||
Option | EmailSubscriptionEnum | Type of notification:
| Yes |
Value | YesNoEnum | Whether to send this type of notification. | Yes |
ClientSettingUpdateItem structure | |||
Option | ClientSettingUpdateEnum | Setting name:
| Yes |
Value | YesNoEnum | Setting value. | Yes |
TinInfoUpdate structure | |||
TinType | TinTypeEnum | Organization type:
| No |
Tin | string | The taxpayer number or its equivalent in the country of registration. | No |
ErirAttributesUpdate structure | |||
Organization | OrganizationUpdate | Details about the organization of the end-advertiser. | No |
Contract | ContractUpdate | Details of the contract of the client counterparty with the end-advertiser. | No |
Contragent | ContragentUpdate | Information about the counterparty of the end-advertiser. | No |
OrganizationUpdate structure | |||
Name | string | Organization name (up to 255 characters). | No |
EpayNumber | string | The number of the electronic payment instrument (up to 255 characters). | No |
RegNumber | string | Registration number or its equivalent (up to 255 characters). | No |
OksmNumber | string | Legal entity's code of the country of registration according to OKSM (up to 3 characters, numbers only). | No |
OkvedCode | string | Business category code according to OKVED. | No |
ContractUpdate structure | |||
Number | string | Contract number (up to 255 characters). | No |
Date | string | Contract date in YYYY-MM-DD format (no earlier than January 01, 1991). | No |
Type | ContractTypeEnum | Type of contract:
| No |
ActionType | ContractActionTypeEnum | Types of activities of the intermediary representative:
| No |
SubjectType | ContractSubjectTypeEnum | Contract subject:
| No |
Price | ContractPrice | Contract price (no more than two decimal digits allowed). | No |
ContractPrice structure | |||
Amount | decimal | The value of the contract. | Yes |
IncludingVat | YesNoEnum | Whether VAT is included in the contract value. | Yes |
ContragentUpdate structure | |||
Name | string | Name (up to 255 characters). | No |
Phone | string | Phone number (50 characters maximum, only numbers allowed, starting with the country code). | No |
EpayNumber | string | The number of the electronic payment instrument (up to 255 characters). | No |
RegNumber | string | Registration number or its equivalent (up to 255 characters). | No |
OksmNumber | string | Legal entity's code of the country of registration according to OKSM (up to 3 characters, numbers only). | No |
TinInfo | TinInfoUpdate | Tax details of the counterparty. | No |
Response
Response structure in JSON format:
{
"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 */
}
}
Parameter | Type | Description |
Result structure (for JSON) / UpdateResponse structure (for SOAP) | ||
---|---|---|
UpdateResults | array of ClientsActionResult | The result of changing parameters for agency client advertisers and user settings for chief representatives of advertisers. |
ClientsActionResult structure | ||
ClientId | long | Advertiser ID. Returned if there aren't any 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. |
Parameter | Type | Description |
Result structure (for JSON) / UpdateResponse structure (for SOAP) | ||
---|---|---|
UpdateResults | array of ClientsActionResult | The result of changing parameters for agency client advertisers and user settings for chief representatives of advertisers. |
ClientsActionResult structure | ||
ClientId | long | Advertiser ID. Returned if there aren't any 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. |