POST
/
v1
/
links
curl --request POST \
  --url https://api.sharefast.me/v1/links \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "my-link",
  "domain": "shfst.me",
  "expiresIn": "5m"
}'
{
  "data": {
    "id": "01JQ3V76YZG9H1TP6CT1B4FEZJ",
    "name": "my-link",
    "domain": "https://shfst.me",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
    "expiresIn": "5m"
  },
  "messages": [
    {
      "code": "LINK_CREATED",
      "message": "Link created successfully."
    }
  ],
  "success": true
}

Body

application/json
​
name
string

Custom URL name.

Required string length: 2 - 32
Example:

"my-link"

​
domain
enum<string>
default:shfst.me

Domain to use for the URL.

Available options:
shfst.me,
sharefast.me
Example:

"shfst.me"

​
expiresIn
enum<string>
default:5m

When the link should expire.

Available options:
5m,
1h,
12h,
24h,
48h,
7d,
12d,
30d,
60d
Example:

"5m"

Response

200
application/json
Successful request.
​
data
object
required

The data returned by the request.

​
success
boolean
required

A flag indicating if the request was successful.

Example:

true

​
messages
object[]

A list of messages returned by the request.

Link created successfully.

Was this page helpful?