Sign in

v1

latestOpenAPI 3.0.12026-07-243266138.0 KB
Endpoints

Create a veto for a review

This endpoint creates a veto for the specified review. A veto flags a review as inappropriate and suggests that the review should be removed or investigated. Veto objects consist of a comment, a reason and the associated channel name.

Note that whenever this method is called, eTrusted will create a ticket in Trusted Shops' Review Team board containing the veto data for further investigation.

post/reviews/{reviewId}/vetos

Path parameters

reviewIdstring required

The review ID.

Request body

commentstring required

The veto comment. Provide additional information on the review or your veto here.

reasonstring required

The reason for the veto.

This string may only have the following values:

  • UNTRUTHFUL
  • ABUSIVE,
  • VIOLATES_THE_TERMS_OF_USE
  • INAPPROPRIATE_IMAGE
vetoReporterEmailstring

The E-Mail address of the veto reporter.

channelNamestring

The name of the channel the review is associated with.

Example request

{
  "comment": "My veto comment.",
  "reason": "UNTRUTHFUL",
  "vetoReporterEmail": "my-name@my-domain.com",
  "channelName": "My channel name."
}

Response

The veto has been saved succesfully.

idstring required

The veto UUID.

ticketIdstring required

A reference to the ticket that was created internally at Trusted Shops for this veto. The ID is a sequence of six digits.

commentstring required

The comment in the ticket that was created internally at Trusted Shops for this veto.

reasonstring required

The reason for this veto.

This string may only have the following values:

  • UNTRUTHFUL
  • ABUSIVE
  • VIOLATES_THE_TERMS_OF_USE
  • INAPPROPRIATE_IMAGE
createdAtstring date-time required

The date and time when the veto was created, in the ISO 8601 and RFC 3339 compliant format yyyy-MM-dd’T’HH:mm:ss.SSSZ.

updatedAtstring date-time

The date and time when the veto was last modified, in the ISO 8601 and RFC 3339 compliant format yyyy-MM-dd’T’HH:mm:ss.SSSZ.

Example response

{
  "id": "vet-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
  "ticketId": "123123",
  "comment": "example comment",
  "reason": "UNTRUTHFUL",
  "createdAt": "2018-02-01T17:09:41.790Z",
  "updatedAt": "2018-02-01T17:09:41.790Z"
}