Skip to main content
POST
/
api
/
v1
/
oauth-app
/
{provider}
Create OAuth App
curl --request POST \
  --url https://api.example.com/api/v1/oauth-app/{provider} \
  --header 'Content-Type: application/json' \
  --header 'x-calry-api-key: <api-key>' \
  --data '
{
  "name": "staging-hostfully-oauth-app",
  "client_id": "XXXXXXXXXX",
  "client_secret": "XXXXXXXXXX",
  "scopes": "read_listings write_listings read_bookings"
}
'
{
  "timestamp": "2025-03-05T11:45:49.631Z",
  "path": "<URL_PATH>",
  "message": "Authentication failed",
  "details": []
}

Authorizations

​
x-calry-api-key
string
header
required

Path Parameters

​
provider
enum<string>
required

Integration provider for the OAuth app

Available options:
BOOKINGSYNC,
GUESTY,
HOSTAWAY,
HOSTFULLY,
HOSTIFY,
INTERHOME,
LODGIFY,
OWNERREZ,
HOSTHUB,
UPLISTING,
BEDS24,
HOST_TOOLS,
HOSTFULLYSANDBOX,
HOSPITABLE,
TOKEET

Body

application/json
​
name
string
required

Name of the OAuth application

Example:

"staging-hostfully-oauth-app"

​
client_id
string
required

Provider Client ID for the OAuth Application. Refer to the provider documentation for more information.

Example:

"XXXXXXXXXX"

​
client_secret
string
required

Provider Client Secret for the OAuth Application. Refer to the provider documentation for more information.

Example:

"XXXXXXXXXX"

​
scopes
string
required

OAuth scopes required for the application. Refer to the provider documentation for more information.

Example:

"read_listings write_listings read_bookings"

Response

OAuth app created successfully