v11

latestOpenAPI 3.0.1raw.githubusercontent.com2025-07-2818719.5 KB
Products

Patch product by gateway account ID and product external ID

patch/v1/api/gateway-account/{gatewayAccountId}/products/{productExternalId}

Path parameters

gatewayAccountIdinteger required
productExternalIdstring required

Request body

amount_hintstring
descriptionstring
metadataobject[]
namestring
priceinteger
reference_enabledboolean
reference_hintstring
reference_labelstring

Example request

{
  "amount_hint": "Enter an amount in multiples of £2 for the number of permits required",
  "description": "New description of the product",
  "name": "name-for-product",
  "price": 1240,
  "reference_enabled": true,
  "reference_hint": "This can be found on your letter",
  "reference_label": "Amount for your licence 2"
}

Response

No content