Create Short URL

post

https://msgi.me/v2/links

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This endpoint allows you to programmatically create short URLs for longer URL (a 'destination'). That is, each short URL you create can be used to redirect the end user (person clicking on the link) to the destination URL.

To use the Shortener API, you can choose to bind your own branded domain, sub-domain, or to use our default domain → msgi.me

Therefore, the URL Shortener API is a service that takes a long, complicated URL and turns it into a shorter, easier-to-remember one.

NOTE:

If you want to use your own branded domain (Custom Domain), contact our support team, and we will be pleased to provide you with technical assistance soon.
You are only able to create a custom domain per owner.

To know how to create a single short URL, go to the Creating Short URL section.

Body Params

longUrl

string

required

URL destination name.

Enter the URL link to which the short URL will redirect.

data

object

This array can be used by the customer to enter and store additional information about the short URL.

This additional information must be set in JSON format at key/value level.

For example:

'data': { 'name': 'Elizabeth Smith', 'email': '[email protected]' }

externalId

string

Alphanumeric identifier used for reporting purposes.

domain

string

Domain which short URL will belong to (string without http/https or /).

Enter the custom domain in case you have requested it from the support team.

By default is 'msgi.me'

callbacks

array of strings

Webhook URL to notify about the events of the short URL.

The URL is the external callback where the events of the short URL will be registered and published. The following short URL status sent to your callback URL will be the status to be recorded in the callback once end user has clicked on the short URL:

'open': End user clicked on the short URL link.

callbacks

Responses

201Successfully created

400Bad request

401Unauthorized

410Token expired

500Internal server error