Settings

Endpoints related to managing Okendo settings

Review Translation Settings

Update Subscriber Review Translation Settings

post

Authorizations

AuthorizationstringRequired

Body

isGlobalTermsBlocklistEnabledbooleanRequired

A flag which is used to determine whether the Subscriber Review Translation Blocklist will be used when translating Reviews

isProductTermsBlocklistEnabledbooleanRequired

A flag which is used to determine whether Product Review Translation Blocklist will be used when translating Reviews

Responses

200

Updated Subscriber Review Translation Settings Object

application/json

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

post

/review_translation_settings

POST /enterprise/review_translation_settings HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "isGlobalTermsBlocklistEnabled": true,
  "isProductTermsBlocklistEnabled": true
}

{
  "isGlobalTermsBlocklistEnabled": true,
  "isProductTermsBlocklistEnabled": true
}

Retrieve a Subscriber Review Translation Blocklist

get

Authorizations

AuthorizationstringRequired

Responses

200

A Translation Blocklist Object

application/json

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

get

/review_translation_blocklist

GET /enterprise/review_translation_blocklist HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

{
  "blocklistedTerms": [
    "text"
  ]
}

Create/Update a Subscriber Review Translation Blocklist with provided terms

put

Authorizations

AuthorizationstringRequired

Body

blocklistedTermsstring[] · max: 100Optional

Array of blocklisted terms.

Responses

200

A Translation Blocklist Object

application/json

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

422

The request was well-formed but was unable to be followed due to semantic errors.

application/json

put

/review_translation_blocklist

PUT /enterprise/review_translation_blocklist HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "blocklistedTerms": [
    "text"
  ]
}

{
  "blocklistedTerms": [
    "text"
  ]
}

Append a list of terms to the Subscriber Review Translation Blocklist

patch

Authorizations

AuthorizationstringRequired

Body

blocklistedTermsstring[] · max: 100Optional

Array of blocklisted terms.

Responses

200

A Translation Blocklist Object

application/json

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

422

The request was well-formed but was unable to be followed due to semantic errors.

application/json

patch

/review_translation_blocklist

PATCH /enterprise/review_translation_blocklist HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "blocklistedTerms": [
    "text"
  ]
}

{
  "blocklistedTerms": [
    "text"
  ]
}

Delete the Subscriber Review Translation Blocklist

delete

Authorizations

AuthorizationstringRequired

Responses

204

The resource was deleted successfully.

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

delete

/review_translation_blocklist

DELETE /enterprise/review_translation_blocklist HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

No content

Retrieve a Product Review Translation Blocklist

get

Authorizations

AuthorizationstringRequired

Path parameters

productIdstringRequired

The product ID prefixed by a platform identifier.

Example: shopify-123456789

Responses

200

A Translation Blocklist Object

application/json

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

get

/products/{productId}/review_translation_blocklist

GET /enterprise/products/{productId}/review_translation_blocklist HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

{
  "blocklistedTerms": [
    "text"
  ]
}

Create/Update a Product Review Translation Blocklist with provided terms

put

Authorizations

AuthorizationstringRequired

Path parameters

productIdstringRequired

The product ID prefixed by a platform identifier.

Example: shopify-123456789

Body

blocklistedTermsstring[] · max: 100Optional

Array of blocklisted terms.

Responses

200

A Translation Blocklist Object

application/json

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

422

The request was well-formed but was unable to be followed due to semantic errors.

application/json

put

/products/{productId}/review_translation_blocklist

PUT /enterprise/products/{productId}/review_translation_blocklist HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "blocklistedTerms": [
    "text"
  ]
}

{
  "blocklistedTerms": [
    "text"
  ]
}

Append a list of terms to the Product Review Translation Blocklist

patch

Authorizations

AuthorizationstringRequired

Path parameters

productIdstringRequired

The product ID prefixed by a platform identifier.

Example: shopify-123456789

Body

blocklistedTermsstring[] · max: 100Optional

Array of blocklisted terms.

Responses

200

A Translation Blocklist Object

application/json

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

422

The request was well-formed but was unable to be followed due to semantic errors.

application/json

patch

/products/{productId}/review_translation_blocklist

PATCH /enterprise/products/{productId}/review_translation_blocklist HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "blocklistedTerms": [
    "text"
  ]
}

{
  "blocklistedTerms": [
    "text"
  ]
}

Delete the Product Review Translation Blocklist

delete

Authorizations

AuthorizationstringRequired

Path parameters

productIdstringRequired

The product ID prefixed by a platform identifier.

Example: shopify-123456789

Responses

204

The resource was deleted successfully.

401

Authentication credentials are missing or incorrect.

403

The requested resource is forbidden.

application/json

404

The requested resource could not be found.

application/json

delete

/products/{productId}/review_translation_blocklist

DELETE /enterprise/products/{productId}/review_translation_blocklist HTTP/1.1
Host: api.okendo.io
Authorization: Basic username:password
Accept: */*

No content

PreviousWebhooks NextOn Site Widgets

Last updated 3 months ago