id |
string |
Link identifier. Read-only. |
code |
string |
Short key. Read-only. |
address |
string |
Long url link to short. |
shortAddress |
string |
Shorted url. Read-only. |
externalGroup |
string |
Meta data top level. |
externalKey |
string |
Meta data second level. |
expirationDelay |
string |
Delay of expiration of the link. Format: "months-x", "year-x", "days-x", "hours-x", "minutes-x". Remplaces x with the count of period. For example "years-2" for a link that expires in 2 years. |
qrCodeLink |
string |
Link of the QR Code of the short url. Read-only. |
Shorten a link
Authentication is required to execute this request. Please contact agendize team to get an authentication token.
| Parameter name | Value | Description |
|---|---|---|
| Required Parameters | ||
address |
string |
Long url link to short. |
| Optional Parameters | ||
externalGroup |
string |
Meta data top level. |
externalKey |
string |
Meta data second level. |
expirationDelay |
string |
Delay of expiration of the link. Format: "months-x", "year-x", "days-x", "hours-x", "minutes-x". Remplaces x with the count of period. For example "years-2" for a link with 2 years of expiration. |
If successful, this method returns a Short URL resource in the response body.
Shorten multiple links
Authentication is required to execute this request. Please contact agendize team to get an authentication token.
| Parameter name | Value | Description |
|---|---|---|
| Required Parameters | ||
items |
string |
Company identifier. |
items[].address |
string |
Long url link to short. |
| Optional Parameters | ||
items[].externalGroup |
string |
Meta data top level. |
items[].externalKey |
string |
Meta data second level. |
items[].expirationDelay |
string |
Delay of expiration of the link. Format: "months-x", "year-x", "days-x", "hours-x", "minutes-x". Remplaces x with the count of period. For example "years-2" for a link with 2 years of expiration. |
If successful, this method returns a response body with the following structure: