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

Contractor's name. You can only use Russian letters. You can also use spaces and dashes (no more than one space and/or dash between words). A dash can't be used at the beginning or end of a sentence.

inn

Contractor's TIN.

type

Contractor type.

Acceptable values:

  • 0: Entity (Russia). Be sure to specify the inn value (10 digits).
  • 1: Individual (Russia). Be sure to specify the inn value (12 digits).
  • 2: Individual entrepreneur (Russia). Be sure to specify the inn value (12 digits).
  • 3: Foreign entity (non-resident). Be sure to fill in the countryOKSM field and one of the following fields: mobilePhone or epayNumber.
  • 4: Foreign individual (non-resident). Be sure to fill in the countryOKSM field and one of the following fields: inn or regNumber.

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

Number of the electronic payment facility.

regNumber

Registration number.

roles[]

Roles that a contractor can assume when entering into a contract.

Acceptable values:

  • 0: Executor.
  • 1: Customer.

isOrs

Is an ad system operator.

Acceptable values:

  • 0: Is not an ad system operator.
  • 1: Is an ad system operator.

isRr

Is an ad distributor.

Acceptable values:

  • 0: Is not an ad distributor.
  • 1: Is an ad distributor.

rsUrl

Ad system URL or other information.

Response format

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

Response parameters

code

Request processing status. If the value is 0, 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):

ID of the object that the action is performed on.

Contractor's name. You can only use Russian letters. You can also use spaces and dashes (no more than one space and/or dash between words). A dash can't be used at the beginning or end of a sentence.

Contractor's TIN.

Contractor type.

Acceptable values:

  • 0: Entity (Russia). Be sure to specify the inn value (10 digits).
  • 1: Individual (Russia). Be sure to specify the inn value (12 digits).
  • 2: Individual entrepreneur (Russia). Be sure to specify the inn value (12 digits).
  • 3: Foreign entity (non-resident). Be sure to fill in the countryOKSM field and one of the following fields: mobilePhone or epayNumber.
  • 4: Foreign individual (non-resident). Be sure to fill in the countryOKSM field and one of the following fields: inn or regNumber.

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.

Number of the electronic payment facility.

Registration number.

Roles that a contractor can assume when entering into a contract.

Acceptable values:

  • 0: Executor.
  • 1: Customer.

Is an ad system operator.

Acceptable values:

  • 0: Is not an ad system operator.
  • 1: Is an ad system operator.

Is an ad distributor.

Acceptable values:

  • 0: Is not an ad distributor.
  • 1: Is an ad distributor.

Ad system URL or other information.

Required parameter.

Previous
contractor
Next
place