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 that the action is performed on.

account

User account. The account name must be unique within the Adfox 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

Access rights setup. Create own campaigns.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

isAdvertisers

Access rights setup. Create own advertisers.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

isModifyAllCampaigns

Access rights setup. Manage all campaigns:

  • 0: Disable.
  • 1: Enable.

isModifyOwnCampaigns

Access rights setup. Manage campaigns assigned to the assistant.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Enabled automatically if the following applies:

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

isViewAllCampaigns

Access rights setup. View all campaigns.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Enabled automatically if the following applies:

  • isModifyAllCampaigns=1: Allowed to manage all campaigns.

isViewOwnCampaigns

Access rights setup. View campaigns assigned to the assistant.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

Enabled automatically if the following applies:

  • 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

Access rights setup. Manage all websites.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

isCommonReports

Access rights setup. Access general reports.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

* Required

Response format

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

Response parameters

code

Request processing status. 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:

Previous
Next