modify

Edit counterparty parameters. Submit only those counterparty parameters that you want to change.

Note

Changing the parameters resubmits the counterparty and any sites they own to the state register for a review.

Request format

https://adfox.yandex.com/api/v1
  ? object=contractor
  & action=modify
  & objectID=<integer>
  & [name=<string>]
  & [inn=<string>]
  & [type=<integer>]
  & [countryOKSM=<string>]
  & [mobilePhone=<string>]
  & [epayNumber=<string>]
  & [regNumber=<string>]
  & [roles[]=<integer>]
  & [isOrs=<integer>]
  & [isRr=<integer>]
  & [rsUrl=<string>]

objectID*

ID of the object that the action is performed on.

name

Counterparty name. You can only use Russian letters. You can also use a space or a hyphen (no more than one space and/or hyphen between words). Hyphens cannot be used at the beginning or end of the string.

inn

Counterparty's INN (TIN).

type

Counterparty type.

Acceptable values:

  • 0: Legal entity (Russia). inn is a required field (10 digits).
  • 1: Individual (Russia). inn is a required field (12 digits).
  • 2: Individual entrepreneur (Russia). inn is a required field (12 digits).
  • 3: Legal entity (Non-resident). Ensure to fill in the countryOKSM field and either the mobilePhone or epayNumber field.
  • 4: Individual (Non-resident). Ensure to fill in the countryOKSM field and either the inn or regNumber field.

countryOKSM

Country of registration code (OKSM).

mobilePhone

Counterparty's phone number. Enter the phone number in the format +[countrycode]{phonenumber}. The phone number can only contain digits (1 to 50) and must not include spaces, hyphens, or other characters.

epayNumber

Electronic payment instrument number.

regNumber

Registration number.

roles[]

The roles the counterparty can have when entering into a contract.

Acceptable values:

  • 0: Contractor.
  • 1: Customer.

isOrs

Specifies if the counterparty is an advertising system operator.

Acceptable values:

  • 0: Not an advertising system operator.
  • 1: Advertising system operator.

isRr

Specifies if the counterparty is an ad distributor.

Acceptable values:

  • 0: Not an ad distributor.
  • 1: Ad distributor.

rsUrl

Advertising system URL or other information.

* Required parameter

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=contractor&action=modify&objectID=543&name=NewContractorName

Response:

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

Other actions with the object

Read about other actions with the contractor object (counterparty):

The ID of the object that the action is performed on.

Counterparty name. You can only use Russian letters. You can also use a space or a hyphen (no more than one space and/or hyphen between words). Hyphens cannot be used at the beginning or end of the string.

Counterparty's INN (TIN).

Counterparty type.

Acceptable values:

  • 0: Legal entity (Russia). inn is a required field (10 digits).

  • 1: Individual (Russia). inn is a required field (12 digits).

  • 2: Individual entrepreneur (Russia). inn is a required field (12 digits).

  • 3: Legal entity (Non-resident). Ensure to fill in the countryOKSM field and either the mobilePhone or epayNumber field.

  • 4: Individual (Non-resident). Ensure to fill in the countryOKSM field and either the inn or regNumber field.

Country of registration code (OKSM).

Counterparty's phone number. Enter the phone number in the format +[countrycode]{phonenumber}. The phone number can only contain digits (1 to 50) and must not include spaces, hyphens, or other characters.

Electronic payment instrument number.

Registration number.

The roles the counterparty can have when entering into a contract.

Acceptable values:

  • 0: Contractor.

  • 1: Customer.

Specifies if the counterparty is an advertising system operator.

Acceptable values:

  • 0: Not an advertising system operator.

  • 1: Advertising system operator.

Specifies if the counterparty is an ad distributor.

Acceptable values:

  • 0: Not an ad distributor.

  • 1: Ad distributor.

Advertising system URL or other information.

Required parameter.

Previous
contractor
Next
place