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)

Name

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.

  • The agency's Chief representative is added to the newly created Yandex ID organization with the Owner role.

  • The user whose token is passed in the Authorization header is added to the Yandex ID organization with the Administrator role.

  • The user whose token is passed in the Member-Authorization header is added to the Yandex ID organization with the Member role.

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

Currency

CurrencyEnum

The advertiser's currency.

Yes

Grants

array of GrantItem

The advertiser's permissions for campaign management. If omitted, there aren't any permissions.

No

Notification

NotificationAdd

Email notification settings for the advertiser's chief representative.

Yes

Settings

array of ClientSettingAddItem

Advertiser settings. Only YES or NO values are allowed.

No

TinInfo

TinInfoAdd

Tax data of the end-advertiser.

Yes

GrantItem structure

Privilege

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

Value

YesNoEnum

Whether the advertiser has this permission.

Yes

NotificationAdd structure

Lang

LangEnum

Language for notifications.

Yes

Email

string

The email address for sending notifications related to the account.

Yes

EmailSubscriptions

array of EmailSubscriptionItem

Types of notifications to send by email.

Yes

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 traffic forecasts falling lower than the bid provided at the time of configuration.

If the type of notification isn't specified, it is created with the value NO.

Yes

Value

YesNoEnum

Whether to send this type of notification.

Yes

ClientSettingAddItem structure

Option

ClientSettingAddEnum

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 Yandex Direct Help).

If the setting isn't specified, it is created with the value NO.

Yes

Value

YesNoEnum

Setting value.

Yes

TinInfoAdd structure

TinType

TinTypeEnum

Organization type:

  • LEGAL: A legal entity.

  • PHYSICAL: An individual.

  • INDIVIDUAL: An individual entrepreneur.

  • FOREIGN_LEGAL: A foreign legal entity.

  • FOREIGN_PHYSICAL: A foreign individual.

Yes

Tin

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)

Login

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.

ClientId

long

ID of the created advertiser. Returned if there are no errors.

Warnings

array of ExceptionNotification

Warnings that occurred during the operation.

Errors

array of ExceptionNotification

Errors that occurred during the operation.