Skip to main content
PATCH
/
api
/
v1
/
integration-account
/
{integrationAccountID}
Update integration account
curl --request PATCH \
  --url https://api.example.com/api/v1/integration-account/{integrationAccountID} \
  --header 'Content-Type: application/json' \
  --header 'x-calry-api-key: <api-key>' \
  --data '
{
  "name": "My Updated Hostaway Account",
  "accountIdentifier": "hostaway-updated-12345",
  "defaultDiscountPercentage": 15,
  "markupPercentage": 7.5,
  "distributionMarkupPercentage": 10,
  "allowImport": true,
  "requireListingApproval": true,
  "status": "ACTIVE",
  "alertsMuted": true
}
'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Hostaway Account",
  "workspaceID": "123e4567-e89b-12d3-a456-426614174000",
  "tenantID": "123e4567-e89b-12d3-a456-426614174000",
  "provider": "HOSTAWAY",
  "providerAccountID": "provider-account-12345",
  "accountIdentifier": "hostaway-12345",
  "authType": "OAUTH",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-02T00:00:00.000Z",
  "status": "ACTIVE",
  "webhooksSubscribed": true,
  "distributionMarkupPercentage": 10,
  "allowImport": true,
  "defaultDiscountPercentage": 10,
  "markupPercentage": 5,
  "tags": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "workspaceID": "<string>",
      "listingIds": [
        [
          "<string>"
        ]
      ],
      "description": "<string>"
    }
  ],
  "alertsMuted": false
}

Authorizations

​
x-calry-api-key
string
header
required

Headers

​
x-calry-tenant-id
string

Optional tenant ID to specify which tenant to operate as. Controls access to integration accounts. If not provided, the default tenant will be used.

Path Parameters

​
integrationAccountID
string
required

The integration account ID to update

Body

application/json
​
name
string

Updated name for the integration account

Example:

"My Updated Hostaway Account"

​
accountIdentifier
string

Updated account identifier, Ensure that it is unique in your workspace

Example:

"hostaway-updated-12345"

​
defaultDiscountPercentage
number

Updated default discount percentage

Required range: 0 <= x <= 100
Example:

15

​
markupPercentage
number

Updated markup percentage

Required range: x >= 0
Example:

7.5

​
distributionMarkupPercentage
number

Updated distribution markup percentage

Required range: 0 <= x <= 100
Example:

10

​
allowImport
boolean

Whether listings from this integration account can be imported by other tenants

Example:

true

​
requireListingApproval
boolean

Whether new listings from sync require manual approval before being marked active

Example:

true

​
status
enum<string>

Updated status for the integration account

Available options:
ACTIVE,
INACTIVE
​
alertsMuted
boolean

Toggle Slack alerts for this integration account

Example:

true

Response

Integration account updated successfully

​
id
string
required

Unique identifier for the integration account

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string
required

Name of the integration account

Example:

"My Hostaway Account"

​
workspaceID
string
required

ID of the workspace this integration account belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
tenantID
string
required

ID of the tenant this integration account belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
provider
enum<string>
required

Integration provider

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

"HOSTAWAY"

​
providerAccountID
string
required

ID of the account in the provider system

Example:

"provider-account-12345"

​
accountIdentifier
string
required

Unique identifier used to reference this account on your system

Example:

"hostaway-12345"

​
authType
enum<string>
required

Type of authentication used for this account

Available options:
ACCESS_TOKEN,
API_KEY,
OAUTH,
EMAIL_PASSWORD,
PARTNER_TOKEN
Example:

"OAUTH"

​
createdAt
string<date-time>
required

When the integration account was created

Example:

"2025-01-01T00:00:00.000Z"

​
updatedAt
string<date-time>
required

When the integration account was last updated

Example:

"2025-01-02T00:00:00.000Z"

​
status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
​
webhooksSubscribed
boolean
required

Indicates whether webhook subscriptions have been completed for this account

Example:

true

​
distributionMarkupPercentage
number
required

Markup percentage applied when other tenants import listings

Example:

10

​
allowImport
boolean
required

Whether listings from this account can be imported by other tenants

Example:

true

​
defaultDiscountPercentage
number

Default discount percentage applied to this account

Required range: 0 <= x <= 100
Example:

10

​
markupPercentage
number

Markup percentage applied to this account

Required range: x >= 0
Example:

5

​
tags
object[]

Tags applied to the integration account

​
alertsMuted
boolean

Whether Slack alerts are muted for this integration account

Example:

false