API Reference

Generate a Shortlink

post
https://api.usebutton.com/v1/shortlink/create/

Generate and return a Button-templated shortlink that redirects to the URL destination specified. This link can then be used by a Creator to link a product and make attributed purchases.

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

The target destination URL, such as https://storeurl.com/products?queryparam=tag12345.

string
required

A Publisher reference value (e.g. a tracking ID) that can be used to associate any value with any downstream Brand activity such as orders, etc. This value will be passed back to you in reporting. String with a maximum length of 512.

string

Your user's unique identifier. Typically a user ID or a stable hash of one. This value will be utilized for reporting performance back to you. Must be a string between 1 and 255 characters long in the ASCII range [0x21-0x7E].

Responses

Updated 6 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Choose an example:
application/json

Updated 6 months ago