modify

Edit user parameters with the “assistant” type.

Request format

https://adfox.yandex.com/api/v1
  ? object=assistant
  & action=modify
  & objectID=<integer>
  & [account=<string>]
  & [eMail=<string>]
  & [company=<string>]
  & [firstName=<string>]
  & [lastName=<string>]
  & [isCreateOwnCampaigns=<integer>]
  & [isAdvertisers=<integer>]
  & [isModifyAllCampaigns=<integer>]
  & [isModifyOwnCampaigns=<integer>]
  & [isViewAllCampaigns=<integer>]
  & [isViewOwnCampaigns=<integer>]
  & [isWebsite=<integer>]
  & [isCommonReports=<integer>]

objectID*

ID of the object the action applies to.

account

User account.

The account name must be unique within the system.

An entry can contain Russian and Latin letters, numbers, and any special characters.

eMail

Email address that the user's access is registered to.

company

Company name.

firstName

User's first name.

lastName

User's last name.

isCreateOwnCampaigns

Setting for configuring access rights. Create own campaigns.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

isAdvertisers

Setting for configuring access rights. Create own advertisers.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

isModifyAllCampaigns

Setting for configuring access rights. Manage all campaigns.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

isModifyOwnCampaigns

Setting for configuring access rights. Manage ad campaigns assigned to the assistant.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

Is enabled automatically if:

  • isCreateOwnCampaigns=1: allowed to create own campaigns.
  • isModifyAllCampaigns=1: allowed to manage all campaigns.

isViewAllCampaigns

Setting for configuring access rights. View all campaigns.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

Enabled automatically if isModifyAllCampaigns=1 (allowed to manage all campaigns).

isViewOwnCampaigns

Setting for configuring access rights. View campaigns assigned to the assistant.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

Is enabled automatically if:

  • isModifyAllCampaigns=1: allowed to manage all campaigns.
  • isCreateOwnCampaigns=1: allowed to create own campaigns.
  • isModifyOwnCampaigns=1 (allowed to manage campaigns assigned to the assistant).

isWebsite

Setting for configuring access rights. Manage all sites.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

isCommonReports

Setting for configuring access rights. Access general reports.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

Response format

<response>
  <status>
    <code>{integer}</code>
  </status>
</response>

Response parameters

code

Request processing status. A value of 0 means the request was completed successfully. For the key, see Error handling.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=assistant&action=modify&objectID=543&company=84993334455

Response:

<response>
  <status>
    <code>0</code>
  </status>
</response>

Other actions with the object

See more actions with the assistant object:

ID of the object the action applies to.

User account.

The account name must be unique within the system.

An entry can contain Russian and Latin letters, numbers, and any special characters.

Email address that the user's access is registered to.

Company name.

User's first name.

User's last name.

Setting for configuring access rights. Create own campaigns.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

Setting for configuring access rights. Create own advertisers.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

Setting for configuring access rights. Manage all campaigns.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

Setting for configuring access rights. Manage ad campaigns assigned to the assistant.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

Is enabled automatically if:

  • isCreateOwnCampaigns=1: allowed to create own campaigns.
  • isModifyAllCampaigns=1: allowed to manage all campaigns.

Setting for configuring access rights. View all campaigns.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

Enabled automatically if isModifyAllCampaigns=1 (allowed to manage all campaigns).

Setting for configuring access rights. View campaigns assigned to the assistant.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

Is enabled automatically if:

  • isModifyAllCampaigns=1: allowed to manage all campaigns.
  • isCreateOwnCampaigns=1: allowed to create own campaigns.
  • isModifyOwnCampaigns=1 (allowed to manage campaigns assigned to the assistant).

Setting for configuring access rights. Manage all sites.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

Setting for configuring access rights. Access general reports.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Default value: 0.

Required parameter.

Previous
Next