API ReferenceTools

Shorten URL

Create a shortened URL with an optional expiration date (default and max expiration is 90 days). The shortened URL will redirect to the original URL and will have the following format https://urls.p1n.io/ABCD5678.

Headers

PINNACLE-API-KeystringRequired

Request

JSON payload containing the URL to be shortened and optional expiration date.
urlstringRequired
The URL to be shortened. Must be a valid URL with either http or https protocol.
expiresAtstringOptionalformat: "date-time"
Optional expiration date for the shortened URL in ISO 8601 format. Default and max expiration is 90 days.

Response

Successfully created shortened URL
shortenedUrlstring or null
The shortened URL.
expiresAtstring or nullformat: "date-time"
The expiration date of the shortened URL, if provided.

Errors