Adding a new or changing a created comment

The method is available for models: FBY, FBS, Express and DBS.

If you are using an API Key token, one of the accesses in the list is required to call the method

Adds a new store comment or modifies a comment that the store left earlier.

To create a comment on a review, send only the review ID. feedbackId.

To add a comment to another comment, send:

  • feedbackId — The review ID.
  • comment.parentId — ID of the parent comment.

To edit a comment, send:

  • feedbackId— The review ID.
  • comment.id — id of the comment to edit.

If you transmit at the same time comment.parentId and comment.id, an existing comment will be changed.

⚙️ Limit: 1 000 requests per hour

Request

POST

https://api.partner.market.yandex.ru/v2/businesses/{businessId}/goods-feedback/comments/update

Path parameters

Name

Description

businessId

Type: integer

Cabinet ID. To find out, use the request GET v2/campaigns.

ℹ️ What is a cabinet and a store on the Market?

Min value: 1

Body

application/json
{
  "feedbackId": 0,
  "comment": {
    "id": 0,
    "parentId": 0,
    "text": "example"
  }
}

Name

Description

comment
Type: object

text

Type: string

The text of the comment.

It must not contain the store's contacts or links to websites other than Yandex.Market.

Min length: 1

Max length: 4096

Example: example

id

Type: integer

ID of the review comment.

parentId

Type: integer

ID of the parent comment to respond to.

A comment on a review or other comment.

Example
{
  "id": 0,
  "parentId": 0,
  "text": "example"
}

feedbackId

Type: integer

The review ID.

Responses

200 OK

Information about the added or changed comment.

Body

application/json
{
  "status": "OK",
  "result": {
    "id": 0,
    "text": "example",
    "canModify": true,
    "parentId": 0,
    "author": {
      "type": "USER",
      "name": "example"
    },
    "status": "PUBLISHED",
    "feedbackId": 0
  }
}

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    The type of response. Possible values:

    • OK — There are no errors.
    • ERROR — an error occurred while processing the request.

    Enum: OK, ERROR

    The standard wrapper for server responses.

    Example
    {
  "status": "OK"
}
  • Type: object

    result
    Type: object

    feedbackId

    Type: integer

    The review ID.

    id

    Type: integer

    ID of the review comment.

    status

    Type: string

    Comment status:

    • PUBLISHED — published.
    • UNMODERATED — not verified.
    • BANNED — blocked.
    • DELETED — deleted.

    Enum: PUBLISHED, UNMODERATED, BANNED, DELETED

    text

    Type: string

    The text of the comment.

    It must not contain the store's contacts or links to websites other than Yandex.Market.

    Min length: 1

    Max length: 4096

    Example: example

    author
    Type: object

    name

    Type: string

    The name of the author or the name of the cabinet.

    Example: example

    type

    Type: string

    Type of author:

    • USER — user.
    • BUSINESS — office.

    Enum: USER, BUSINESS

    Information about the author of the comment.

    Example
    {
  "type": "USER",
  "name": "example"
}

    canModify

    Type: boolean

    Whether the seller can change the comment or delete it.

    parentId

    Type: integer

    ID of the parent comment.

    Comment on the review.

    Example
    {
  "id": 0,
  "text": "example",
  "canModify": true,
  "parentId": 0,
  "author": {
    "type": "USER",
    "name": "example"
  },
  "status": "PUBLISHED",
  "feedbackId": 0
}
    Example
    {
  "result": {
    "id": 0,
    "text": "example",
    "canModify": true,
    "parentId": 0,
    "author": {
      "type": "USER",
      "name": "example"
    },
    "status": "PUBLISHED",
    "feedbackId": 0
  }
}

400 Bad Request

The request contains incorrect data. Learn more about errors when working with product reviews

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

404 Not Found

The requested resource was not found. More information about the error

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

    Example
    {
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

No longer supported, please use an alternative and newer version.

Previous
Comments on the review
Next
Skipping reactions to reviews