POST
/
links

Authorizations

x-api-key
string
headerrequired

Your Short Menu API Key. Create one at shm.to/create-api-key.

Body

application/json
destinationUrl
string
required

Destination URL of the new short link. Must be a valid URL starting with a scheme such as https.

domain
string
required

Name of the short link domain, e.g. shm.to. If your account is set up with custom domains, you can pass their names instead.

slug
string

Optional slug for the new short link. If empty, a random slug will be generated. Must be unique within the domain.

tags
object[]
required

Zero or more tags to assign to the new short link. If a tag with the same name already exists, it will be reused automatically. Do not pass tag id values, unless they already exist in your account.

Response

201 - application/json
id
string
required

Identifier of the short link.

createdAt
string
required

Reference date and time when the short link was created.

destinationUrl
string
required

Destination URL of the short link.

title
string

Title of the destination URL (website), if available.

slug
string
required

Slug of the short link, e.g. ios.

domain
object
required
shortUrl
string
required

Full short URL of the short link, e.g. https://shm.to/ios.

clickCount
number

Number of times the short link has been clicked.

tags
object[]
required

Zero or more tags assigned to the short link.