API Reference

Create a new conversion type.

post
https://platform.routy.app/api/v1/conversion-types

The id is optional and auto-generated when omitted. Pass an empty/null verticalIds
to make the type global (available for all verticals). Requires an authenticated caller.

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

The conversion type definition to create.

Request body to create a new conversion type.

int32 | null

Id to set when adding a new conversion type. this is not required and will be generated automatically if not set

string | null

Required. Machine name/key of the conversion type (used in postbacks and webhooks).

string | null

Required. Human-friendly display name of the conversion type.

int32 | null

Optional id of the paired/opposite conversion type (for example a chargeback paired with a deposit).

string
enum

Uniqueness scope for de-duplicating conversions: Global (1), PerTime (2, per second) or PerDay (3).

Allowed:
boolean

When true, the conversion type carries a monetary value.

boolean

When true (default), conversions of this type can trigger outgoing postbacks.

verticalIds
array of int32s | null

Vertical IDs to assign to this conversion type. Empty array or null = global (available for all verticals).

verticalIds
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