Share
The Sharing module simplifies the creation and sharing of QR codes and short links. Use it to generate QR codes for apps, products, collections, and URLs. Create short links for long URLs and retrieve them, along with the original URLs, using their respective codes.
You can utilize this to create a shortened URL from a long URL, product slug, or collection slug. Given the character limit of URLs in SMS communication (30 characters), employing this shortened URL facilitates easy sharing via SMS and email.
Operations
POST
# Create short link
GET
# Get short links
GET
# Get short link by hash
PATCH
# Update short link
Parameters
company_idpath
string
Required
Company Id
application_idpath
string
Required
Application Id
Request body
title
string
Required
Give a name to the link.
url
string
Required
The web address to shorten.
hash
string
active
boolean
expire_at
string
| date-time
enable_tracking
boolean
personalized
boolean
To create personalized short links.
campaign
object (CampaignShortLink)
Show
redirects
object (Redirects)
Show
attribution
object (Attribution)
Show
social_media_tags
object (SocialMediaTags)
Show
count
integer
meta
object (shortLinkReqMeta)
Show
POST
Response
200
Success
Hide
title
string
url
object (UrlInfo)
Show
created_by
string
app_redirect
boolean
fallback
string
Enum
active
boolean
_id
string
enable_tracking
boolean
expire_at
string
| date-time
application
string
user_id
string
created_at
string
| date-time
meta
object
updated_at
string
| date-time
personalized
boolean
To create personalized short links
campaign
object (CampaignShortLink)
Show
redirects
object (Redirects)
Show
attribution
object (Attribution)
Show
social_media_tags
object (SocialMediaTags)
Show
count
integer
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Response
Create short link
createShortLink
Parameters
company_idpath
string
Required
Company Id
application_idpath
string
Required
Application Id
page_noquery
integer
Current page number
Default Value : 1
page_sizequery
integer
Current page size
Default Value : 10
created_byquery
string
Short link creator
Enum
activequery
string
Short link active status
Enum
short_urlquery
string
Search for short url
original_urlquery
string
Search for original url
titlequery
string
Search text for title
GET
Response
200
Success
Hide
items
array of object (ShortLinkRes)
Show
page
object (Page)
Show
Examples
Parameters
company_id:
"value"
application_id:
"value"
page_no:
1
page_size:
1
created_by:
"value"
active:
"value"
short_url:
"value"
original_url:
"value"
title:
"value"
Response
Get short links
getShortLinks
Parameters
company_idpath
string
Required
Company Id
application_idpath
string
Required
Application Id
hashpath
string
Required
Hash of short url
GET
Response
200
Success
Hide
title
string
url
object (UrlInfo)
Show
created_by
string
app_redirect
boolean
fallback
string
Enum
active
boolean
_id
string
enable_tracking
boolean
expire_at
string
| date-time
application
string
user_id
string
created_at
string
| date-time
meta
object
updated_at
string
| date-time
personalized
boolean
To create personalized short links
campaign
object (CampaignShortLink)
Show
redirects
object (Redirects)
Show
attribution
object (Attribution)
Show
social_media_tags
object (SocialMediaTags)
Show
count
integer
Examples
Parameters
company_id:
"value"
application_id:
"value"
hash:
"value"
Response
Get short link by hash
getShortLinkByHash
Parameters
company_idpath
string
Required
Company Id
application_idpath
string
Required
Application Id
idpath
string
Required
Short link document identifier
Request body
title
string
Required
Give a name to the link.
url
string
Required
The web address to shorten.
hash
string
active
boolean
expire_at
string
| date-time
enable_tracking
boolean
personalized
boolean
To create personalized short links.
campaign
object (CampaignShortLink)
Show
redirects
object (Redirects)
Show
attribution
object (Attribution)
Show
social_media_tags
object (SocialMediaTags)
Show
count
integer
meta
object (shortLinkReqMeta)
Show
PATCH
Response
200
Success
Hide
title
string
url
object (UrlInfo)
Show
created_by
string
app_redirect
boolean
fallback
string
Enum
active
boolean
_id
string
enable_tracking
boolean
expire_at
string
| date-time
application
string
user_id
string
created_at
string
| date-time
meta
object
updated_at
string
| date-time
personalized
boolean
To create personalized short links
campaign
object (CampaignShortLink)
Show
redirects
object (Redirects)
Show
attribution
object (Attribution)
Show
social_media_tags
object (SocialMediaTags)
Show
count
integer
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Response