Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Integrations

Update integration

Selectively update fields of single account integration.

put/integrations/{id}

Path parameters

idstring required

Integration ID

Request body

_idstring

Unique Id

activeboolean

Status of connection

platformstring

Platform information

listingsobject[]
complexesobject[]
nicknamestring

Integration nickname

channelIdstring

Channel Id

proxyEmailstring
incomingEmailstring
externalAccountIdstring
idinteger

External ID

companyNamestring

Company name

status'NOT_CONNECTED' | 'CONNECTING' | 'CONNECTED' | 'FAILED' | 'TIMEOUT' | 'DISCONNECTED' | 'PENDING'

Status of integration

userIdstring
accountIdstring

Owner

tripAdvisorobject

TripAdvisor details

homeaway2object

Homeaway details

missingStepstring

Missing integration step

newIntegrationBackupobject
threadIdsMigratedboolean
isDeletedboolean

Flag to delete integration

Example request

{
  "_id": "5958c7e5884e961000817799",
  "airbnb2": {
    "ignored": {
      "reservations": [],
      "listings": []
    },
    "emailsFromSupport": []
  },
  "platform": "airbnb2",
  "nickname": "naama",
  "channelId": "airbnb2",
  "proxyEmail": "test@user.guesty.com",
  "incomingEmail": "test@user.guesty.com",
  "externalAccountId": "123456789",
  "companyName": "Test company",
  "userId": "563e0b6a08a2710e00057b85",
  "accountId": "563e0b6a08a2710e00057b82",
  "missingStep": "add_account_settings"
}

Response

Integration object

_idstring

Unique Id

activeboolean

Status of connection

platformstring
listingsobject[]
complexesobject[]
nicknamestring
channelIdstring
activatedAtstring

Date

disconnectedAtstring

Date

proxyEmailstring
incomingEmailstring
externalAccountIdstring
idinteger

External ID

companyNamestring
status'NOT_CONNECTED' | 'CONNECTING' | 'CONNECTED' | 'FAILED' | 'TIMEOUT' | 'DISCONNECTED' | 'PENDING'
userIdstring
accountIdstring

Owner

tripAdvisorobject

TripAdvisor details

homeaway2object

Homeaway details

createdAtstring

Date

missingStepstring
newIntegrationBackupobject
threadIdsMigratedboolean
isDeletedboolean
deletedAtstring

Date

Example response

{
  "_id": "5958c7e5884e961000817799",
  "airbnb2": {
    "ignored": {
      "reservations": [],
      "listings": []
    },
    "emailsFromSupport": []
  },
  "nickname": "naama",
  "userId": "563e0b6a08a2710e00057b85",
  "accountId": "563e0b6a08a2710e00057b82"
}