Settings

Endpoints related to managing Okendo settings

Review Translation Settings

Update Subscriber Review Translation Settings

post
Authorizations
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
post
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
Responses
200

A Translation Blocklist Object

application/json
get
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
Body
blocklistedTermsstring[] · max: 100Optional

Array of blocklisted terms.

Responses
200

A Translation Blocklist Object

application/json
put
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
Body
blocklistedTermsstring[] · max: 100Optional

Array of blocklisted terms.

Responses
200

A Translation Blocklist Object

application/json
patch
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
Responses
204

The resource was deleted successfully.

No content

delete
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
Path parameters
productIdstringRequired

The product ID prefixed by a platform identifier.

Example: shopify-123456789
Responses
200

A Translation Blocklist Object

application/json
get
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
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
put
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
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
patch
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
Path parameters
productIdstringRequired

The product ID prefixed by a platform identifier.

Example: shopify-123456789
Responses
204

The resource was deleted successfully.

No content

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

No content

Last updated