Skip to main content
PUT
Enable/disable or re-point one of this customer's destinations

Authorizations

Authorization
string
header
required

A hpt_… customer portal token, as Authorization: Bearer. Stored hashed; shown once at issue.

Path Parameters

id
string
required

Destination id. The update is scoped to the token's tenant, portal and customer, so another customer's id simply does not match.

Query Parameters

token
string

Portal access token (hpt_…), as an alternative to the Authorization: Bearer header.

Body

application/json

Only enabled and url can be changed. name and dataset_filter are NOT updatable through the portal (silently ignored), as are all server-controlled columns (secret, created_by, tenant_id, project_id, portal_id, customer_id). An absent or unparseable body is treated as {} — which re-enables the destination, since enabled defaults to 1.

enabled
boolean

Only the literal JSON false disables the destination. Any other value — true, null, a string, or the field being absent — sets enabled = 1.

url
string<uri>

Applied only when it is a string starting with https:// (case-insensitive); any other value is silently ignored and the stored URL is kept. A non-https url here is NOT an error.

Pattern: ^[Hh][Tt][Tt][Pp][Ss]://

Response

Updated (also returned when the values were unchanged but the row matched).

ok
enum<boolean>
required
Available options:
true