Skip to main content
PATCH
Update a Five9 Domain's margins and lanes

Authorizations

X-API-Key
string
header
required

Path Parameters

tenancy_id
string
required

Body

application/json

Admin edits to a Domain: per-bucket safety margins and lane placement.

All three fields are optional and an omitted field is left untouched rather than cleared. margins is keyed on the rate bucket (the provider's own operation-type name), so a safety margin can be applied to one bucket without affecting the others; values are a percentage of the provider cap and are downward-only. lane_overrides moves one action into a different named dispatch lane for this Domain, and lane_order fixes the order actions run in within a lane as an ordered list of action ids rather than numeric weights.

margins
Margins · object | null
lane_overrides
Lane Overrides · object | null
lane_order
Lane Order · object | null

Response

Successful Response

One Five9 Domain: the provider-tenant record that anchors rate limits.

N Connections resolving to the same Domain share ONE quota budget. Each rate bucket reports the provider's raw caps per time window, the operator's margin_pct safety margin, and the effective budget computed from both. tenancy_unit carries the platform's own vocabulary for this record so it can be labelled correctly without a second lookup, and sync_status reports whether the caps are provider-observed (live), catalog defaults (catalog_default), or unchanged after a refresh returned unusable counters (stale).

id
string
required
org_id
string
required
platform_id
string
required
domain_id
string
required
domain_name
string
required
api_host
string
required
tenancy_unit
Tenancy Unit · object
required
buckets
Buckets · object
required
bucket_map
Bucket Map · object
required
lane_overrides
Lane Overrides · object
required
lane_order
Lane Order · object
required
sync_status
string
required
counters_synced_at
string<date-time> | null
required
status
string
required
created_at
string<date-time>
required
updated_at
string<date-time> | null
required