API reference / Admin

patch/v1/admin/products/{code}/availability

Show or hide one product

Operation
adminUpdateProductAvailability
Authentication
API key

Hiding a product removes it from the public catalogue and stops new applications using it; applications already created keep the quote they were priced against.

Request

Parameters

codepathrequiredstring

Body

activebooleanrequired

Responses

200Updated product availability.

Free-form JSON object.

400The request body or query failed validation.
errorobjectrequired
401No key, an unknown key, a revoked key, or a key whose tenant is not active. All four return an identical body on purpose: distinguishing them would let a caller discover which partners we have.
errorobjectrequired
403`projects:write` is required. No partner key is ever issued this scope.
errorobjectrequired
404Not found, or not yours. A resource belonging to another tenant answers 404 rather than 403, because 403 would confirm the record exists.
errorobjectrequired

Example

curl
curl -X PATCH https://api.haavisa.com/v1/admin/products/<code>/availability \
  -H "Authorization: Bearer $HAAVISA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "active": true
  }'

More in Admin

Something unclear? The eligibility guide explains the model behind the answers; the errors guide covers the envelope.