Skip to main content
PUT
Edit, pause or resume one of this customer's destinations

Authorizations

Authorization
string
header
required

A hpt_… customer portal token, as Authorization: Bearer. Stored hashed and looked up by its full SHA-256 hash; shown once at issue. The query string (?token=) is not accepted: a token there ends up in request logs and traces. A browser page trades the token for a portalSession cookie with POST /portal/api/session.

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.

Body

application/json

Only what is sent changes. Audited as update_destination with the customer (portal|<customer_id>) as the actor. Turning a destination back on sends what it held while paused.

name
string
Required string length: 1 - 80
url
string<uri>

https only.

dataset_filter
string[]

Event types (datasets) this destination receives: a non-empty subset of the portal's event_types. Anything outside them, or an empty list, is a 400.

Minimum array length: 1
enabled
boolean

Response

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

ok
enum<boolean>
required
Available options:
true