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_id
string
Required
Company Id
application_id
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)
CampaignShortLink
source
string
medium
string
redirects
object (Redirects)
Redirects
ios
object (RedirectDevice)
RedirectDevice
link
string
type
string
Enum
android
object (RedirectDevice)
RedirectDevice
link
string
type
string
Enum
web
object (WebRedirect)
WebRedirect
link
string
type
string
Enum
force_web
boolean
attribution
object (Attribution)
Attribution
campaign_cookie_expiry
string
social_media_tags
object (SocialMediaTags)
SocialMediaTags
title
string
description
string
image
string
count
integer
meta
object (shortLinkReqMeta)
shortLinkReqMeta
for_sms
boolean
for_sms flag specifies that the short-link will be used in SMS communication and based on TRAI (Indian) guidelines, the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
sms_header
string
This field is used to override the sms header to be used to generate a short-link for SMS communication in compliance with TRAI guidelines, this should be used in conjunction with for_sms flag set to true.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
4XX
Success
ShortLinkRes
title
string
url
object (UrlInfo)
UrlInfo
original
string
hash
string
short_url
string
alias
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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)
CampaignShortLink
source
string
medium
string
redirects
object (Redirects)
Redirects
ios
object (RedirectDevice)
RedirectDevice
link
string
type
string
Enum
android
object (RedirectDevice)
RedirectDevice
link
string
type
string
Enum
web
object (WebRedirect)
WebRedirect
link
string
type
string
Enum
force_web
boolean
attribution
object (Attribution)
Attribution
campaign_cookie_expiry
string
social_media_tags
object (SocialMediaTags)
SocialMediaTags
title
string
description
string
image
string
count
integer
Examples
Parameters
company_id:
"value"
application_id:
"value"
body:
body
Was this section helpful?
POST
Response
Parameters
company_id
string
Required
Company Id
application_id
string
Required
Application Id
page_no
integer
Current page number
Default Value : 1
page_size
integer
Current page size
Default Value : 10
created_by
string
Short link creator
Enum
active
string
Short link active status
Enum
short_url
string
Search for short url
original_url
string
Search for original url
title
string
Search text for title
Response
200
4XX
Success
ShortLinkList
items
array of object (ShortLinkRes)
Array of ShortLinkRes
title
string
url
object (UrlInfo)
UrlInfo
original
string
hash
string
short_url
string
alias
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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)
CampaignShortLink
source
string
medium
string
redirects
object (Redirects)
Redirects
ios
object (RedirectDevice)
RedirectDevice
link
string
type
string
Enum
android
object (RedirectDevice)
RedirectDevice
link
string
type
string
Enum
web
object (WebRedirect)
WebRedirect
link
string
type
string
Enum
force_web
boolean
attribution
object (Attribution)
Attribution
campaign_cookie_expiry
string
social_media_tags
object (SocialMediaTags)
SocialMediaTags
title
string
description
string
image
string
count
integer
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
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"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Company Id
application_id
string
Required
Application Id
hash
string
Required
Hash of short url
Response
200
4XX
Success
ShortLinkRes
title
string
url
object (UrlInfo)
UrlInfo
original
string
hash
string
short_url
string
alias
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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)
CampaignShortLink
source
string
medium
string
redirects
object (Redirects)
Redirects
ios
object (RedirectDevice)
RedirectDevice
link
string
type
string
Enum
android
object (RedirectDevice)
RedirectDevice
link
string
type
string
Enum
web
object (WebRedirect)
WebRedirect
link
string
type
string
Enum
force_web
boolean
attribution
object (Attribution)
Attribution
campaign_cookie_expiry
string
social_media_tags
object (SocialMediaTags)
SocialMediaTags
title
string
description
string
image
string
count
integer
Examples
Parameters
company_id:
"value"
application_id:
"value"
hash:
"value"
Was this section helpful?
GET
Response
Parameters
company_id
string
Required
Company Id
application_id
string
Required
Application Id
id
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)
CampaignShortLink
source
string
medium
string
redirects
object (Redirects)
Redirects
ios
object (RedirectDevice)
RedirectDevice
link
string
type
string
Enum
android
object (RedirectDevice)
RedirectDevice
link
string
type
string
Enum
web
object (WebRedirect)
WebRedirect
link
string
type
string
Enum
force_web
boolean
attribution
object (Attribution)
Attribution
campaign_cookie_expiry
string
social_media_tags
object (SocialMediaTags)
SocialMediaTags
title
string
description
string
image
string
count
integer
meta
object (shortLinkReqMeta)
shortLinkReqMeta
for_sms
boolean
for_sms flag specifies that the short-link will be used in SMS communication and based on TRAI (Indian) guidelines, the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
sms_header
string
This field is used to override the sms header to be used to generate a short-link for SMS communication in compliance with TRAI guidelines, this should be used in conjunction with for_sms flag set to true.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
4XX
Success
ShortLinkRes
title
string
url
object (UrlInfo)
UrlInfo
original
string
hash
string
short_url
string
alias
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
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)
CampaignShortLink
source
string
medium
string
redirects
object (Redirects)
Redirects
ios
object (RedirectDevice)
RedirectDevice
link
string
type
string
Enum
android
object (RedirectDevice)
RedirectDevice
link
string
type
string
Enum
web
object (WebRedirect)
WebRedirect
link
string
type
string
Enum
force_web
boolean
attribution
object (Attribution)
Attribution
campaign_cookie_expiry
string
social_media_tags
object (SocialMediaTags)
SocialMediaTags
title
string
description
string
image
string
count
integer
Examples
Parameters
company_id:
"value"
application_id:
"value"
id:
"value"
body:
body
Was this section helpful?
PATCH
Response