Create Shortened URL | Pinnacle

Create a shortened URL that redirects visitors to the provided destination URL.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

urlstringRequired

Destination URL for the shortened link that visitors will be redirected to when clicked.

optionsobjectOptional

Response

Successfully created.

urlstring

Your custom shortened link following the format https://pncl.to/{linkId}, where {linkId} is the unique identifier for the URL that can be used with our other endpoint.

configobject

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	environment: "https://api.pinnacle.sh",
6	});
7	await client.tools.url.create({
8	url: "https://www.pinnacle.sh/",
9	options: {
10	expiresAt: "2025-06-23T16:18:25.000Z",
11	},
12	});
13	}
14	main();

1	{
2	"url": "https://pncl.to/hJCJadm9",
3	"config": {
4	"to": "https://docs.pinnacle.sh/",
5	"expiresAt": "2025-06-23T16:18:25+00:00"
6	}
7	}

Authentication

Request

Response

Errors