Create Link

Creates a new link within the workspace.

HTTP Request

POST https://dev.calry.app/api/v1/link

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN
Content-Type	application/json

Request Body

The request body should be a JSON object containing the following fields:

Field	Required	Type	Description
integrationDefinitionKey	Yes	string	Integration definition key you want to restrict the link to a specific integration.
expiresIn	Yes	number	Link expires after the specified seconds.
linkName	Yes	string	Name of the link, used to easily search for it in UI.
workspaceId	Yes	string	Unique identifier used to identify all the other resources.
accountIdentifier	Yes	string	Identifier for the account from your system.
redirectUrl	Yes	string	URL to redirect the user after the authentication process.
preferOAuth	Optional	bool	Optional. Specifies whether to restrict the authentication type to OAuth flow.

Integration Definition Keys:

Integration Name	Integration Definition Key
OwnerRez	ownerrez
OwnerRez Sandbox	ownerrez-sandbox
Hostaway	hostaway
Hostfully	hostfully
Hostfully Sandbox	hostfully-sandbox
Guesty	guesty
Lodgify	lodgify
Beds24	beds24
Hostify	hostify
Smoobu	smoobu
Uplisting	uplisting
Lodgix	lodgix
Tokeet	tokeet
Hospitable	hospitable
Hostex	hostex
Elina	elina
Your Rentals	your-rentals
BookingSync	bookingsync
AvaiBook	avaibook
Direct Software	direct
FantasticStay	fantasticstay
Mr Alfred	mralfred
Resly	resly
Cloudbeds	cloudbeds
Zeevou	zeevou

Link Status

SUCCEEDED = 'SUCCEEDED',
FAILED = 'FAILED',
PENDING = 'PENDING',

Example cURL Request

curl --location 'https://dev.calry.app/api/v1/link' \
--header 'Authorization: Bearer eyJraWQiOiJzLTc2Mjc5OGM2LTkzYmEtNGNhMC1hZDNlLWEwMWM2ODIyODMyNiIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjY5MmZiYTg2LTJkMzgtNDAzOC04MWY2LTBkZmVkYWRkY2Q5YiIsIndvcmtzcGFjZUlkIjoiNzNhYTUwZGUtMGNiMi00ZjRlLTk5YjctN2JmMzdmMjU3Y2E2IiwibmFtZSI6IndlZnJ3ZSIsInNvdXJjZSI6Im1pY3Jvc2VydmljZSIsImlhdCI6MTcwNjI4ODQ1OCwiZXhwIjoxNzI4NTEwNjgwfQ.Z4bZJuRBQymkSmZoQzqjwjOTxqpzJVLcSV_DLBHMSv61bgZy3lr-ZMz61drgoAWaH8pXb77sw8mfTCfyVc_2RCxeMeKQJMPBeGyivS4IUyc0N-fBdEeTGb5bff6AVC-YGPPOIWpM2dRpye7pX5B2V_9CUcEi9ZMKxWLJTKr5uHpIkUBQfXg35HcRfvaNVl8CPzc7GfRq7aBK-YtT-9DUDsYvlRXM0FQcqiwgoR4pNeTZh7VvYOhgNAaaJo-Zm5SvLkUnlRG6eHcg6pYe0Ackv5ZZLAzyIAMVXHVUdwuwYUjqE7cLEDSMtSWdeMxs0RiJc2a19XPF8TxhnQNy7485xQ' \
--header 'Content-Type: application/json' \
--data '{
    "integrationDefinitionKey": "ownerrez",
    "expiresIn": 3600,
    "linkName": "OwnerRez Link",
    "workspaceId": "1fe8897a-795c-47e7-ad4a-7adb82027bc7",
    "accountIdentifier": "qwert-323433761-4216-9d0f",
    "redirectUrl": "https://calry.app"
    "preferOAuth": true
}'

Response

{
    "linkId": "8eb7f1bc-8364-4239-aa37-1a94bbfc2db5",
    "linkName": "OwnerRez Link",
    "canExpire": false,
    "expiresIn": 3600,
    "integrationDefinitionId": "552ccf2b-61f9-4549-b71f-ca9bf5fd7bc1",
    "workspaceId": "1fe8897a-795c-47e7-ad4a-7adb82027bc7",
    "createdAt": "2024-02-01T10:48:59.159Z",
    "updatedAt": "2024-02-01T10:48:59.159Z",
    "status": "PENDING",
    "accountIdentifier": "qwert-323433761-4216-9d0f",
    "redirectUrl": "https://calry.app",
    "integrationDefinitionKey": "ownerrez"
}