Short URL

Create, update or delete Short URL (Short Links, Tiny URLs) using a custom domain with Click Analytics for any link using the Short URL connector. The connector is a companion of a Short URL for SharePoint. Short URL allows the creation and use of vanity and shortcut hyperlinks fully integrated within SharePoint!

Status: Preview

Tier: Premium

Version: v1

Actions:

Name	Summary
ShortUrl_CreateShortUrl (string longUrl, string baseDomain, string username, string licenseKey, [Optional]string shortUrl, [Optional]string generatedBy, [Optional]integer maxUses, [Optional]string password, [Optional]string expiryDate, [Optional]string redirectionCode)	Create Short URL
ShortUrl_DeleteShortUrl (string shortUrl, string baseDomain, string username, string licenseKey)	Delete Short URL
ShortUrl_GetAllShortUrls (string baseDomain, string username, string licenseKey, [Optional]string generatedBy)	Get All Short URL
ShortUrl_ModifyShortUrl (string shortUrl, string baseDomain, string username, string licenseKey, [Optional]string newLongUrl, [Optional]string password, [Optional]integer maxUses, [Optional]string expiryDate, [Optional]string redirectionCode)	Modify Short URL properties

Triggers:

Name

Summary

Objects:

Name	Summary
ShortUrl_CreateShortUrlResponse
ShortUrl_DeleteShortUrlResponse
ShortUrl_GetAllShortUrlsResponse
ShortUrl_ModifyShortUrlResponse

Actions:

ShortUrl_CreateShortUrl

Summary: Create Short URL

Description: This action allows you to generate a Short URL or Tiny link for your long URL.

Syntax:

ShortURL.ShortUrl_CreateShortUrl (string longUrl, string baseDomain, string username, string licenseKey, [Optional]string shortUrl, [Optional]string generatedBy, [Optional]integer maxUses, [Optional]string password, [Optional]string expiryDate, [Optional]string redirectionCode)

Parameters:

Name	Type	Summary	Required	Related Action
longUrl	string (Long URL)	Specify the long URL which you would like to shortern.	True
baseDomain	string (Base Domain)Values: [surl.link, surl.ms, sharepointurl.com, officeurl.com]	Specify the base domain of the Short URL. Example: surl.link	True
username	string (Username)	Specify the ShortURLApp Username for authentication and authorization.	True
licenseKey	string (License Key)	Specify the ShortURLApp License Key for authentication and authorization.	True
shortUrl	string (Desired Short URL)	Specify the unique Short URL. If blank a random unique Short URL will be generated.	False
generatedBy	string (Short URL Created By)	Specify the user email who is generating Short URL. This will help you in report generation for all generated Short URLs.	False
maxUses	integer(int32) (Max Uses)	Specify the total number use (Number of times a user can access the Short URL).	False
password	string (Password)	Specify a Password to access the Short URL.	False
expiryDate	string (Expiry Date)	Specify the expiry date for the Short URL (yyyy-MM-dd format). Leave blank for no expiry date.	False
redirectionCode	string (Redirection Type)Values: [301 - Moved Permanently, 307 - Temporary Redirect]	Specify the Redirection Type.	False

Returns:

Type:ShortUrl_CreateShortUrlResponse

ShortUrl_DeleteShortUrl

Summary: Delete Short URL

Description: This action allows you to delete any existing Short URL which was created previously.

Syntax:

ShortURL.ShortUrl_DeleteShortUrl (string shortUrl, string baseDomain, string username, string licenseKey)

Parameters:

Name	Type	Summary	Required	Related Action
shortUrl	string (Short URL)	Specify the Short URL which you would like to delete.	True
baseDomain	string (Base Domain)Values: [surl.link, surl.ms, sharepointurl.com, officeurl.com]	Specify the base domain of the Short URL. Example: surl.link	True
username	string (Username)	Specify the ShortURLApp Username for authentication and authorization.	True
licenseKey	string (License Key)	Specify the ShortURLApp License Key for authentication and authorization.	True

Returns:

Type:ShortUrl_DeleteShortUrlResponse

ShortUrl_GetAllShortUrls

Summary: Get All Short URL

Description: This action allows you to get list of all Short URL generated with specified Username and License Key

Syntax:

ShortURL.ShortUrl_GetAllShortUrls (string baseDomain, string username, string licenseKey, [Optional]string generatedBy)

Parameters:

Name	Type	Summary	Required	Related Action
baseDomain	string (Base Domain)Values: [surl.link, surl.ms, sharepointurl.com, officeurl.com]	Specify the base domain of the Short URL. Example: surl.link	True
username	string (Username)	Specify the ShortURLApp Username for authentication and authorization.	True
licenseKey	string (License Key)	Specify the ShortURLApp License Key for authentication and authorization.	True
generatedBy	string (Short URL Created By)	Provide a list of all Short URLs created by a specified user email. If blank, it will return all Short URLs.	False

Returns:

Type:ShortUrl_GetAllShortUrlsResponse

ShortUrl_ModifyShortUrl

Summary: Modify Short URL properties

Description: This action is allows you to modify/update properties for any existing Short URL.

Syntax:

ShortURL.ShortUrl_ModifyShortUrl (string shortUrl, string baseDomain, string username, string licenseKey, [Optional]string newLongUrl, [Optional]string password, [Optional]integer maxUses, [Optional]string expiryDate, [Optional]string redirectionCode)

Parameters:

Name	Type	Summary	Required	Related Action
shortUrl	string (Short URL)	Specify the Short URL which properties you would like to update.	True
baseDomain	string (Base Domain)Values: [surl.link, surl.ms, sharepointurl.com, officeurl.com]	Specify the base domain of the Short URL. Example: surl.link	True
username	string (Username)	Specify the ShortURLApp Username for authentication and authorization.	True
licenseKey	string (License Key)	Specify the ShortURLApp License Key for authentication and authorization.	True
newLongUrl	string (New Long URL)	Specify the new long URL. User will redicted to this URL when they try to access the specified Short URL.	False
password	string (Password)	Specify a Password to access the Short URL.	False
maxUses	integer(int32) (Max Uses)	Specify the total number use (Number of times a user can access the Short URL).	False
expiryDate	string (Expiry Date)	Specify the expiry date for the Short URL (yyyy-MM-dd format). Leave blank for no expiry date.	False
redirectionCode	string (Redirection Type)Values: [301 - Moved Permanently, 307 - Temporary Redirect]	Specify the Redirection Type.	False