Update product settings

Updates one or more product settings fields. Changing currency re-enables previously disabled prices in the new currency on the latest plans of that product.

PATCH /catalog/products/{pk}/settings/

Update product settings

cURL

curl --request PATCH \
  --url https://api.kelviq.com/api/v1/catalog/products/{pk}/settings/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vpn": false,
  "tor": false,
  "proxy": true,
  "currency": "EUR",
  "productUrl": "https://app.example.com"
}
'

200

{
  "vpn": true,
  "tor": true,
  "proxy": true,
  "currency": "USD",
  "productUrl": "https://app.example.com"
}

Authorizations

Authorization · string · header · required

The Server API Key obtained from the kelviq application. Pass as a Bearer token in the Authorization header. Example: 'Authorization: Bearer YOUR_API_KEY'

Path Parameters

pk · string<uuid> · required

Product UUID.

Body

application/json

Partial update to product settings. Any subset of fields may be supplied.

vpn · boolean

Example:

false

tor · boolean

Example:

false

proxy · boolean

Example:

true

currency · string

Example:

"EUR"

productUrl · string<uri>

Example:

"https://app.example.com"

Response

200

application/json

Updated product settings.

Behavioural and presentation settings attached to a product.

vpn · boolean

If true, VPN traffic is allowed for this product's experience.

Example:

true

tor · boolean

If true, Tor traffic is allowed.

Example:

true

proxy · boolean

If true, proxy traffic is allowed.

Example:

true

currency · string

Default currency for the product.

Example:

"USD"

productUrl · string<uri> | null

Public URL of the product.

Example:

"https://app.example.com"