API Reference

Create a new traffic source.

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

Requires the TrafficSourceUpdate policy and an affiliate context (RequiredAffiliate).
On success returns the new traffic source id wrapped in a CreatedResponse<int> with a
Location header pointing at the get-by-id endpoint.

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

🔐 Requires an Affiliate context (AffiliateId in header or token)

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

The traffic source to create.

Request body for creating a traffic source.

int32 | null

Owning affiliate id. Optional; when omitted the caller's affiliate context is used.

uri | null

Website URL associated with the traffic source. Optional. Serialized as website.

string | null

Human-readable display name. Required.

string | null

Optional prefix used to namespace dynamic tracking parameters. Serialized as dynamicPrefix.

string
enum

The kind of traffic source (Platform.Models.TrafficSources.AddTrafficSourceRequest.TrafficSourceType enum).

asset
object | null

Optional asset (pixel/JS) configuration to attach on creation.

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