API Reference

Update an existing traffic source.

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

Requires the TrafficSourceUpdate policy. Fields modelled with Optional<T>
(status, host name, traffic source type) are only applied when present in the request body.

🔐 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 source to update.

Body Params

The fields to update.

Request body for updating a traffic source. Fields modelled with Optional<T> are only
applied when present in the payload; absent optionals leave the existing value unchanged.

int32 | null

Owning affiliate id. Optional.

string | null

Display name.

string
enum
Allowed:
string

Host name for the source. Applied only when present (may be set to null).

string | null

Optional prefix used to namespace dynamic tracking parameters.

boolean | null

When true, anonymise the visitor IP. Optional.

boolean | null

When true, suppress the URL referrer. Optional.

string
enum
asset
object | null

Optional asset (pixel/JS) configuration to update.

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