API Reference

Update an existing traffic control.

put
https://platform.routy.app/api/v1/traffic-controls/

Requires the EditTrafficControl policy. Same authorization rules as setting a control apply.

🔐 Required permissions: traffic-source.read, traffic-source.update

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Numeric id of the traffic control to update.

Body Params

The updated control values.

Request model for setting or updating a traffic control

int32 | null

The affiliate ID this control applies to.
Required for admin operations, inferred from context for affiliate self-service.

string
enum

The surface a traffic control applies to. Each type supports a different set of
Platform.Models.TrafficControl.TrafficControlLevel values and Platform.Models.TrafficControl.TrafficControlStatus behaviors.

Allowed:
string
enum
required

Defines the level at which traffic control is applied.
Every traffic control record ALWAYS has an affiliate_id.
The level determines what additional dimensions are being controlled.

Allowed:
int32 | null

The traffic source this control applies to (required for TrafficSource and LinkTrafficSource levels)

int32 | null

The brand link this control applies to (required for Link and LinkTrafficSource levels)

string
enum
required

Defines the traffic control status and its behavior.

Allowed:
string
required
length between 10 and 2000

Mandatory comment explaining why this control is being set (minimum 10 characters)

date-time | null

Optional auto-release timestamp. Traffic control will automatically release at this time.

boolean

Whether to notify the affiliate about this control (admin only, not applicable for self-service)

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago