Set a new traffic control

post

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

Affiliates can only set TrafficSource, Link, or LinkTrafficSource level controls for their own affiliate.
Admins can set any level including Affiliate level. Requires the EditTrafficControl policy.
On success returns the new control id as a CreatedResponse<int>.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The traffic control to set (level, target ids, status).

Request model for setting or updating a traffic control

affiliateId

int32 | null

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

type

string

enum

The surface this control applies to (click, collector, api). Defaults to Click.

Allowed:

level

string

enum

required

The level at which control is applied

Allowed:

trafficSourceId

int32 | null

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

linkId

int32 | null

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

status

string

enum

required

The status/behavior to apply

Allowed:

comment

string

required

length between 10 and 2000

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

autoReleaseAt

date-time | null

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

notifyAffiliate

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:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200The created traffic control id.

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error