addPassportOrganization
Creates a business account for the organization.
Note
For requests to the AgencyClients
service:
- In the
Authorization
header, specify the access token you obtained for the agency representative. - In the
Member-Authorization
HTTP header, specify the token for the username to be added to the business account as a Member
Learn more
Request
Request structure in JSON format:
{
"method": "addPassportOrganization",
"params": {
"Name": (string),
"Currency": ("RUB"|"BYN"|"CHF"|"EUR"|"KZT"|"TRY"|"UAH"|"USD"),
"Grants": [{
"Privilege": ("EDIT_CAMPAIGNS"|"IMPORT_XLS"|"TRANSFER_MONEY"),
"Value": ("YES"|"NO")
}, ... ],
"Notification":
"Lang": ("RU"|"UK"|"EN"|"TR"),
"Email": (string),
"EmailSubscriptions": [{
"Option": ("RECEIVE_RECOMMENDATIONS"|"TRACK_MANAGED_CAMPAIGNS"|"TRACK_POSITION_CHANGES"),
"Value": ("YES"|"NO")
}, ... ],
"Settings": [{
"Option": ("CORRECT_TYPOS_AUTOMATICALLY"|"DISPLAY_STORE_RATING"),
"Value": ("YES"|"NO")
}, ... ],
"TinInfo": {
"TinType": ("PHYSICAL"|"FOREIGN_PHYSICAL"|"LEGAL"|"FOREIGN_LEGAL"|"INDIVIDUAL" ),
"Tin": (string)
}
}
}
Parameter |
Type |
Description |
Required |
params structure (for JSON) / AddPassportOrganization (for SOAP) |
|||
|
string |
The name of the organization in Yandex ID that will act as the advertiser's chief representative. The automatically generated username of the Yandex ID organization will be displayed in the Yandex Direct account. A new Yandex ID organization is created for the specified name in Yandex ID and linked to the agency's business group. Learn more about organizations.
Learn more about employee roles in Yandex ID organizations The username may include Latin characters, digits, a single hyphen, and a dot. It must be no longer than 30 characters. The following characters are not allowed: |
Yes |
|
CurrencyEnum |
The advertiser's currency. |
Yes |
|
array of GrantItem |
The advertiser's permissions for campaign management. If omitted, there aren't any permissions. |
No |
|
NotificationAdd |
Email notification settings for the advertiser's chief representative. |
Yes |
|
array of ClientSettingAddItem |
Advertiser settings. Only YES or NO values are allowed. |
No |
|
TinInfoAdd |
Tax data of the end-advertiser. |
Yes |
GrantItem structure |
|||
|
PrivilegeEnum |
Name of the permission:
If the permission isn't specified, it is created with the value NO. 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. |
Yes |
|
YesNoEnum |
Whether the advertiser has this permission. |
Yes |
NotificationAdd structure |
|||
|
LangEnum |
Language for notifications. |
Yes |
|
string |
The email address for sending notifications related to the account. |
Yes |
|
array of EmailSubscriptionItem |
Types of notifications to send by email. |
Yes |
EmailSubscriptionItem structure |
|||
|
EmailSubscriptionEnum |
Type of notification:
If the type of notification isn't specified, it is created with the value NO. |
Yes |
|
YesNoEnum |
Whether to send this type of notification. |
Yes |
ClientSettingAddItem structure |
|||
|
ClientSettingAddEnum |
Setting name:
If the setting isn't specified, it is created with the value NO. |
Yes |
|
YesNoEnum |
Setting value. |
Yes |
TinInfoAdd structure |
|||
|
TinTypeEnum |
Organization type:
|
Yes |
|
string |
The taxpayer number or its equivalent in the country of registration. |
Yes |
Response
Response structure in JSON format:
{
"result": {
"Login": (string),
"ClientId": (long),
"Warnings": [{
"Code": (int),
"Message": (string),
"Details": (string)
}, ... ],
"Errors": [{
"Code": (int),
"Message": (string),
"Details": (string)
}, ... ]
}
}
Parameter |
Type |
Description |
result structure (for JSON) / AddResponse structure (for SOAP) |
||
|
string |
Username of a Yandex Direct user who is the chief representative of an advertiser. Returned if there aren't any errors. See the section Operations on object arrays. |
|
long |
ID of the created advertiser. Returned if there are no errors. |
|
array of ExceptionNotification |
Warnings that occurred during the operation. |
|
array of ExceptionNotification |
Errors that occurred during the operation. |