Skip to main content
POST
Create a link

Authorizations

Authorization
string
header
required

Tolt API key sent as a bearer token.

Body

application/json
value
string
required

Slug that identifies the partner in referral URLs, such as sam in ?ref=sam, saved in lowercase. Pick one that no other link uses with the same parameter; a taken slug returns an error.

Required string length: 1 - 255
partner_id
string
required

Id of the partner who owns the link (part_...), as returned when listing partners. The link is created in that partner's program.

Minimum string length: 1
param
string

Query parameter of the link, e.g. ref in ?ref=sam. Leave it out or send an empty string to use the program's first link parameter, which is what gets stored.

Maximum string length: 255

Response

The created link

success
boolean
required
Example:

true

message
string
required
Example:

"Request successful"

data
object
required