GUguesty
Integrations

Update an integration

Changed on

Selectively update fields of single account integration.

put/integrations/{id}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/integrations/{id}
  • Auth
    API key in header authorization

Path parameters

idstring required

Integration ID

Request body

_idstring

Unique Id

activeboolean

Status of connection

platformstring

Platform information

listingsobject[]

Listings associated with the integration.

complexesobject[]

Complexes (multi-listing property groups) associated with the integration.

nicknamestring

Integration nickname

channelIdstring

Channel Id

proxyEmailstring email

Proxy email address used for guest communication through this integration.

incomingEmailstring email

Email address used to receive incoming messages for this integration.

externalAccountIdstring

Account identifier on the external platform.

idstring

External ID

companyNamestring

Company name

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

Status of integration

userIdstring

Id of the user who owns/created the integration.

accountIdstring

Owner

tripAdvisorobject

TripAdvisor details

homeaway2object

Homeaway details

missingStepstring

Missing integration step

newIntegrationBackupobject

Backup snapshot of integration data taken before migrating to a new integration.

threadIdsMigratedboolean

Whether message thread IDs have been migrated for this integration.

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",
  "id": "naama@user.guesty.com",
  "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
idstring

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",
  "id": "naama@user.guesty.com",
  "userId": "563e0b6a08a2710e00057b85",
  "accountId": "563e0b6a08a2710e00057b82"
}

Changes

  • 3122b8618183Revision changes
    • breaking

      the // request property format changed from no format to int64

    • breaking

      the // request property format changed from no format to date-time

    • breaking

      the // request property format changed from no format to date-time

    • breaking

      the // request property format changed from no format to date-time

    • breaking

      the // request property format changed from no format to date-time

    • breaking

      the request property type changed from integer to string

    • breaking

      the request property format changed from no format to email

    • breaking

      the / request property format changed from no format to date-time

    • breaking

      the // request property format changed from no format to date-time

    • breaking

      the / request property format changed from no format to date-time

    • breaking

      the / request property format changed from no format to date-time

    • breaking

      the request property format changed from no format to email

    • breaking

      the response's property type changed from integer to string for status

    • info

      api operation id accountsIntegrationUpdate was added