API Reference

Creates a new brand link.

post
https://platform.routy.app/api/v1/accounts/links

Requires the EditAccount policy.

🔐 Required permissions: accounts.read, accounts.update

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

The request containing brand-link details to create.

Request payload for creating a new brand link.

int32

Required. The Routy internal account id the brand link belongs to.

int32

Required. The brand id the link points to.

string | null

Required. Display name for the brand link.

string | null

Required. The destination URL.

int32 | null

Optional. The product-category id.

string
enum

The kind of destination a brand link points to. Serialized by default as its numeric value.

Allowed:
int32 | null

Optional. The assigned commission-plan id.

string | null

Optional. Free-text description.

int32 | null

Optional. The associated account tracking-profile id.

string | null

Optional. Free-text comments.

string | null

Optional. Language code (e.g. ISO 639-1).
Note: this property is serialized under the JSON key languageCoe (a misspelling of "languageCode")
for backward compatibility; clients must send the value under that exact key.

string | null

Optional. Country code (ISO 3166-1 alpha-2).

string | null

Optional. Currency code (ISO 4217).

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