Back to top

DefaultPoliciesWereChanged

{
  "accountId": "845cd158-ea91-45f9-a30d-f4a1b7deb3aa",
  "occurredOn": "2017-06-30T14:08:48+0000",
  "content": {
    "locale": "es",
    "translationType": "automatic",
    "translationProvider": "google",
    "policies": "* Idiomas hablados: Ingl\\u00e9s, espa\\u00f1ol, franc\\u00e9s, alem\\u00e1n e italiano\\n* Vive en la propiedad: no\\n* Posibilidad de domiciliaci\\u00f3n: s\\u00ed\\n* M\\u00e9todo del pago: transacci\\u00f3n bancaria (orden permanente)\\n* Se permite fumar: no\\n* Se admiten animales dom\\u00e9sticos: no\\n* ** El inquilino debe proporcionar los siguientes documentos: **\\n\\u00a0* Fotocopia de pasaporte\\n\\u00a0* Contrato de trabajo\\n\\u00a0Schufa\\n\\u00a0* Copia de la orden permanente para el pago del alquiler\\n* No se permiten hu\\u00e9spedes a largo plazo\\n* Los inquilinos no pueden subarrendar"
  }
}
  • accountId (string, required)

  • occurredOn (string, required)

  • content (object, required)

    • locale (string, required)
    • translationType (enum[string], required)
      • automatic
      • manual
    • translationProvider (string, nullable, required)
    • policies (string, required)
AccountClassificationWasUpdated
{
  "accountId": "6b953172-6777-4205-9a07-7808448adbb1",
  "accountClassification": "key",
  "occurredOn": "2017-04-28T09:46:02+0000"
}
  • accountId (string, required)

  • accountClassification (string, required)

  • occurredOn (string, required)

AccountManagerWasAssigned
{
  "accountId": "6b953172-6777-4205-9a07-7808448adbb1",
  "accountManager: "lovelace@spotahome.com",
  "occurredOn": {
    "date": "2017-07-20 14:09:40.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  }
}
  • accountId (string, required)

  • accountManager (string, required)

  • occurredOn (object, required)

    • date (string, required)
    • timezone_type (int, required)
    • timezone (string, required)
AccountManagerWasUnassigned
{
  "accountId": "6b953172-6777-4205-9a07-7808448adbb1",
  "accountManager": "lovelace@spotahome.com",
  "occurredOn": {
    "date": "2017-07-20 14:09:40.000000",
    "timezone_type": 3,
    "timezone": "UTC"
  }
}
  • id (string, required)

  • accountManager (string, required)

  • occurredOn (object, required)

    • date (string, required)
    • timezone_type (int, required)
    • timezone (string, required)
CancellationPolicyWasUpdated
{
  "accountId": "6b953172-6777-4205-9a07-7808448adbb1",
  "cancellationPolicy": "strict",
  "occurredOn": "2017-07-20T09:36:48+0000"
}
  • accountId (string, required)

  • cancellationPolicy (string, required)

  • occurredOn (string, required)

CommissionWasUpdated
{
  "id": "6b953172-6777-4205-9a07-7808448adbb1",
  "occurredOn": "2017-07-20T16:04:34+0000",
  "type": "percentage",
  "value": 0,
}
  • id (string, required)

  • occurredOn (string, required)

  • type (enum[string], required)

    • fixed
    • percentage
  • value (number, required)

DownPaymentPreferenceWasUpdated
{
  "accountId": "6b953172-6777-4205-9a07-7808448adbb1",
  "occurredOn": "2017-07-20T15:59:09+0000",
  "downPaymentPreference": {
    "type": {
      "type": "monthly"
    }
  }
}
  • accountId (string, required)

  • occurredOn (string, required)

  • downPaymentPreference (object, required)

    • type (object, required)
      • type (enum[string], required)
        • monthly
        • weekly
      • numberOfWeeks (number, optional)
FirstListingWasPublished
{
  "accountId": "6b953172-6777-4205-9a07-7808448adbb1",
  "occurredOn": "2017-07-21T00:42:56+0000"
}
  • accountId (string, required)

  • occurredOn (string, required)

ContractTypeWasChanged
{
  "accountId": "6b953172-6777-4205-9a07-7808448adbb1",
  "contractType": "daily",
  "occurredOn": "2017-07-20T15:59:09+0000"
}
  • accountId (string, required)

  • contractType (enum[string], required)

    • daily
    • fortnightly
    • monthly
  • occurredOn (string, required)

UpdateAvailabilitiesNotificationWasSent
{
  "accountId": "6b953172-6777-4205-9a07-7808448adbb1",
  "occurredOn": "2017-07-20T19:30:10+0000"
}
  • accountId (string, required)

  • occurredOn (string, required)

ContactTypesWereReassigned
{
  "accountId": "6b953172-6777-4205-9a07-7808448adbb1",
  "occurredOn": "2017-07-20T15:59:09+0000",
  "assignation": {
    "booking_manager": 200,
    "tenant": 300,
    "finance": 125
  }
}
  • accountId (string, required)

  • occurredOn (string, required)

  • assignation (object, required)

    • booking_manager (number, required)
    • tenant (number, required)
    • finance (number, required)
AccountWasCreated
{
  "accountId": "abcdef-123456",
  "accountName": "Landlords S.L.",
  "accountEmail": "landlords@bestflatsever.com",
  "locale": "en",
  "contractType": "daily",
  "commission": {
      "value": 1000,
      "type": "fixed"
  }
  "type": "private",
  "fees": {
    "booking": {
      "type": "fixed",
      "value": 2500
    }
  },
  "downPaymentPreference": {
      "type": "monthly",
      "numberOfWeeks": null
  }
  "totalRentableUnits": 5,
  "totalProperties": 1,
  "contactCollection": {
      "contacts": [
        {
          "id": 15533,
          "firstName": "pp",
          "lastName": "pp",
          "email": "pruebapru@gmail.com",
          "phone": "+34690377481",
          "address": "",
          "zipCode": "",
          "position": null,
          "notes": "",
          "accounting": {
            "creationUser": "albertolopez@spotahome.com",
            "updateUser": "albertolopez@spotahome.com",
            "creationDate": "2017-07-27T09:18:08+0000",
            "updateDate": "2017-07-27T09:18:08+0000"
          },
          "isDeleted": false
        }
      ],
      "contactTypesAssignation": {
        "booking_manager": 15533,
        "tenant": 15533,
        "finance": 15533
      }
  },
  "activationStage": "converted",
  "occurredOn": "2017-07-21T12:48:44+0000",
  "user": {
       "email": "user@spotahome.com",
       "identity": "asdf-12-adafafdas-343-adasdfasd"
  },
  "source": "outbound",
  "isNotifiable": true,
  "accountPlan": "standard"
}
  • accountId (string, required)

  • accountName (string, required)

  • accountEmail (string, required)

  • locale (string, required)

  • commission (object, required)

    • type (string, required)
    • value (int, required)
  • type (string, required)

  • fees (object, required)

    • booking (object, required)
      • type (string, required)
      • value (int, required)
  • contractType (string, required)

  • downPaymentPreference (object, required)

    • type (string, required)
    • numberOfWeeks (number, nullable)
  • totalRentableUnits (number, required)

  • totalProperties (number, required)

  • contactCollection (object, required)

    • contacts (array, required)
      • (object)
        • id (string, required)
        • firstName (string, required)
        • lastName (string, required)
        • email (string, required)
        • phone (string, required)
        • address (string)
        • zipCode (string)
        • position (string)
        • notes (string)
        • accounting (object)
          • creationUser (string, required)
          • updateUser (string, required)
          • creationDate (string, required)
          • updateDate (string, required) -isDeleted (boolean, required)
    • contactTypesAssignation (object)
      • booking_manager (number)
      • tenant (number)
      • finance (number)
  • occurredOn (string, required)

  • user (string, object)

    • email (string, required, nullable)
    • identity (string, required)
  • source (enum[string], required)

    • inbound
    • outbound
AccountWasObfuscated
{
  "accountId": "abcdef-123456",
  "user": {
       "email": "user@spotahome.com",
       "identity": "asdf-12-adafafdas-343-adasdfasd"
  },
  "occurredOn": "2017-07-21T12:48:44+0000"
}
  • accountId (string, required)

  • user (string, object)

    • identity (string, required)
  • occurredOn (string, required)

AccountContentWasUpdated
{
  "accommodationProvider": {
    "id": "67c0f631-6922-4a20-943b-ad634869b3b7",
    "uuid": "1c06ad85-7841-421e-abf9-b04061f6c68b",
    "accountName": "Mr Foo",
    "accountEmail": {
      "email": "mrfoo@spotahome.net"
    },
    "commission": {
      "percentage": 4
    },
    "type": {
      "type": "private"
    },
    "locale": "it",
    "fees": {
      "booking": {
        "value": 0
      }
    },
    "contractType": {
      "type": "daily"
    },
    "downPaymentPreference": {
      "type": {
        "type": "monthly"
      }
    },
    "accounting": {
      "creationUser": "creator@spotahome.com",
      "updateUser": "updater@spotahome.com",
      "creationDate": "2017-04-21T16:56:14+0000",
      "updateDate": "2017-08-17T07:22:48+0000",
      "firstListingPublicationDate": "2017-04-23T02:11:36+0000"
    },
    "notes": "Fake St 123",
    "isDeleted": false,
    "translatableContentCollection": {
      "canonicalLocale": "en",
      "translatableContents": [
        {
          "locale": "en",
          "translationType": "manual",
          "policies": "Cachopo policies"
        },
        {
          "locale": "es",
          "translationType": "automatic",
          "translationProvider": "fake",
          "policies": "(es) Cachopo policies"
        }
      ]
    },
    "isExternallyIntegrated": false,
    "cancellationPolicy": {
      "policy": "standard"
    },
    "bookingAcceptanceTimePreferences": {
      "maxGapBetweenBookings": {},
      "bookingAcceptanceDaysRange": {}
    },
    "accountClassification": {
      "type": "opportunistic"
    },
    "assignedAccountManager": {
      "username": "unassigned"
    },
    "numberPublishedListings": 1,
    "contractProvision": {
      "provision": "unknown"
    },
    "preferredCommunicationChannel": {
      "channel": "no_preference"
    },
    "totalRentableUnits": 0,
    "totalProperties": 0,
    "contactCollection": {
      "contacts": [
        {
          "id": 15534,
          "firstName": "Bruce",
          "lastName": "Lee",
          "email": {
            "email": "dragon@spotahome.com"
          },
          "phone": "+34698171297",
          "address": "",
          "zipCode": "",
          "position": "",
          "notes": "Punch!",
          "accounting": {
            "creationUser": "creator@spotahome.com",
            "updateUser": "updater@spotahome.com",
            "creationDate": "2017-08-01T13:36:41+0000",
            "updateDate": "2017-08-01T13:36:41+0000"
          },
          "isDeleted": false
        }
      ],
      "contactTypesAssignation": {
        "assignations": {
          "tenant": 14423,
          "booking_manager": 14423,
          "finance": 14423
        }
      }
    }
  },
  "contentBefore": {
    "locale": "en",
    "translationType": "manual",
    "policies": "ouch"
  },
  "contentAfter": {
    "locale": "en",
    "translationType": "manual",
    "policies": "WDFA!"
  }
}
  • accommodationProvider (object, required)
    • id (string, required)
    • uuid (string, required)
    • accountName (string, required)
    • accountEmail (object, required)
      • email (string, required)
    • commission (object, required)
      • percentage (number, optional)
      • fixed (number, optional)
    • type (object, required)
      • type (string, required)
    • locale (string, required)
    • fees (object, required)
    • contractType (object, required)
      • type (string, required)
    • downPaymentPreference
      • type (object, required)
        • type (string, required)
    • accounting (object, required)
      • creationUser (string, required)
      • updateUser (string, required)
      • creationDate (string, required)
      • updateDate (string, required)
      • firstListingPublicationDate (string, required)
    • notes (string, required)
    • isDeleted (bool, required)
    • translatableContentCollection (object, required)
      • canonicalLocale (string, required)
      • translatableContents (array, required)
        • (object)
          • locale (string, required)
          • translationType (string, required)
          • policies (string, required)
    • isExternallyIntegrated (bool, required)
    • cancellationPolicy (object, required)
      • policy (string, required)
    • bookingAcceptanceTimePreferences (object, required)
      • maxGapBetweenBookings (object, required)
        • days (number, optional)
      • bookingAcceptanceDaysRange (object, required)
        • minDays (number, optional)
        • maxDays (number, optional)
    • accountClassification (object, required)
      • type (string, required)
    • assignedAccountManager (object, required)
      • username (string, required)
    • numberPublishedListings (number, required)
    • contractProvision (object, required)
      • provision (string, required)
    • preferredCommunicationChannel (object, required)
      • channel (string, required)
    • totalRentableUnits (number, required)
    • totalProperties (number, required)
    • contactCollection (object, required)
      • contacts (array, required)
        • (object)
          • id (number, required)
          • firstName (string, required)
          • lastName (string, required)
          • email (object, required)
            • email (string, required)
          • phone (string, required)
          • address (string, required)
          • zipCode (string, required)
          • position (string, required)
          • notes (string, required)
          • accounting (object, required)
            • creationUser (string, required)
            • updateUser (string, required)
            • creationDate (string, required)
            • updateDate (string, required)
    • contactTypesAssignation (object, required)
      • assignations (object, required)
    • contentBefore (object, required) - locale (string, required) - translationType (string, required) - policies (string, optional)
    • contentAfter (object, required) - locale (string, required) - translationType (string, required) - policies (string, optional)
AccountPlanWasChanged
{
  "accountId": "abcdef-123456",
  "accountPlan": "plus",
  "user": {
    "identity": "asdf-12-adafafdas-343-adasdfasd"
  },
  "occurredOn": "2017-07-21T12:48:44+0000"
}
  • accountId (string, required)

  • accountPlan (string, required)

  • user (string, object)

    • identity (string, required)
  • occurredOn (string, required)

MarketPenetrationInfoWasChanged
{
  "accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
  "totalProperties": 2,
  "totalRentableUnits": 2,
  "user": {
    "email": "user@spotahome.com",
    "identity": "asdf-12-adafafdas-343-adasdfasd"
  },
  "occurredOn": "2017-06-30T14:08:48+0000",

}
  • accountId (string, required)

  • totalProperties (number, required)

  • totalRentableUnits (number, required)

  • occurredOn (string, required)

  • user (object, required)

    • email (string, required, nullable)
    • identity (string, required)

AccountTechnologyWasChanged

{
  "accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
  "technology": "no_technology",
  "user": {
    "email": "user@spotahome.com",
    "identity": "asdf-12-adafafdas-343-adasdfasd"
  },
  "occurredOn": "2017-08-18T13:37:36+0000",
}
  • accountId (string, required)

  • technology (string, required)

  • user (object, required)

    • email (string, required, nullable)
    • identity (string, required)
  • occurredOn (string, required)

AccountAdditionalDataWasCreated

{
  "id": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
  "data": {
      "additionalLanguagesSpoken": "Spanish, French",
      "deposit": 400,
      "rentPaymentMethod": "Credit",
      "costOfTenantContractRegistration": 25,
      "isDomiciliationPermitted": true,
      "isAnmeldungPermitted": true,
      "documentationRequired": "DNI",
      "doesTheLandlordLiveOnTheProperty": false,
      "landlordGender": "Male",
      "landlordAge": 31,
      "aboutLandlord": "The landlord is always quick to help with any issue her tenants might have with the property",
      "hasCheckoutCleaningFee": true,
      "checkoutCleaningFeeAmount": 50,
      "hasCheckinCheckoutPolicies": true,
      "checkinCheckoutLocation": "Calle de Vizcaya, 12, 28045 Madrid",
      "earliestCheckinCheckoutTime": "13:00/17:00",
      "latestCheckinCheckoutTime": "13:00/17:00",
      "isWeekendHolidayOutOfHoursCheckinCheckoutPermitted": false,
      "weekendHolidayCheckinCheckoutFeeAmount": 25,
  },
  "user": {
    "email": "user@spotahome.com",
    "identity": "asdf-12-adafafdas-343-adasdfasd"
  },
  "occurredOn": "2017-08-18T13:37:36+0000",
}
  • accountId (string, required)

  • data (object, required)

    • additionalLanguagesSpoken (string, optional)
    • deposit (number, optional)
    • rentPaymentMethod (string, optional)
    • costOfTenantContractRegistration (number, optional)
    • isDomiciliationPermitted (boolean, optional)
    • isAnmeldungPermitted (boolean, optional)
    • documentationRequired (string, optional)
    • doesTheLandlordLiveOnTheProperty (boolean, optional)
    • landlordGender (string, optional)
    • landlordAge (number, optional)
    • aboutLandlord (string, optional)
    • hasCheckoutCleaningFee (boolean, optional)
    • checkoutCleaningFeeAmount (number, optional)
    • hasCheckinCheckoutPolicies (boolean, optional)
    • checkinCheckoutLocation (string, optional)
    • earliestCheckinCheckoutTime (string, optional)
    • latestCheckinCheckoutTime (string, optional)
    • isWeekendHolidayOutOfHoursCheckinCheckoutPermitted (boolean, optional)
    • weekendHolidayCheckinCheckoutFeeAmount (number, optional)
  • user (object, required)

    • email (string, required, nullable)
    • identity (string, required)
  • occurredOn (string, required)

AccountAdditionalDataWasUpdated

{
  "id": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
  "data": {
      "additionalLanguagesSpoken": "Spanish, French",
      "deposit": 400,
      "rentPaymentMethod": "Credit",
      "costOfTenantContractRegistration": 25,
      "isDomiciliationPermitted": true,
      "isAnmeldungPermitted": true,
      "documentationRequired": "DNI",
      "doesTheLandlordLiveOnTheProperty": false,
      "landlordGender": "Male",
      "landlordAge": 31,
      "aboutLandlord": "The landlord is always quick to help with any issue her tenants might have with the property",
      "hasCheckoutCleaningFee": true,
      "checkoutCleaningFeeAmount": 50,
      "hasCheckinCheckoutPolicies": true,
      "checkinCheckoutLocation": "Calle de Vizcaya, 12, 28045 Madrid",
      "earliestCheckinCheckoutTime": "13:00/17:00",
      "latestCheckinCheckoutTime": "13:00/17:00",
      "isWeekendHolidayOutOfHoursCheckinCheckoutPermitted": false,
      "weekendHolidayCheckinCheckoutFeeAmount": 25,
  },
  "user": {
    "email": "user@spotahome.com",
    "identity": "asdf-12-adafafdas-343-adasdfasd"
  },
  "occurredOn": "2017-08-18T13:37:36+0000",
}
  • accountId (string, required)

  • data (object, required)

    • additionalLanguagesSpoken (string, optional)
    • deposit (number, optional)
    • rentPaymentMethod (string, optional)
    • costOfTenantContractRegistration (number, optional)
    • isDomiciliationPermitted (boolean, optional)
    • isAnmeldungPermitted (boolean, optional)
    • documentationRequired (string, optional)
    • doesTheLandlordLiveOnTheProperty (boolean, optional)
    • landlordGender (string, optional)
    • landlordAge (number, optional)
    • aboutLandlord (string, optional)
    • hasCheckoutCleaningFee (boolean, optional)
    • checkoutCleaningFeeAmount (number, optional)
    • hasCheckinCheckoutPolicies (boolean, optional)
    • checkinCheckoutLocation (string, optional)
    • earliestCheckinCheckoutTime (string, optional)
    • latestCheckinCheckoutTime (string, optional)
    • isWeekendHolidayOutOfHoursCheckinCheckoutPermitted (boolean, optional)
    • weekendHolidayCheckinCheckoutFeeAmount (number, optional)
  • user (object, required)

    • email (string, required, nullable)
    • identity (string, required)
  • occurredOn (string, required)

AccountNameWasChanged

{
  "id": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
  "name": "name",
  "occurredOn": "2017-08-18T13:37:36+00:00",
}
  • id (string, required)

  • name (string, required)

  • occurredOn (string, required)

AccountTypeWasChanged

{
  "id": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
  "type": "property_manager",
  "occurredOn": "2017-08-18T13:37:36+00:00",
}
  • id (string, required)

  • type (string, required)

  • occurredOn (string, required)

AccountAdminFeeWasUpdated

{
  "accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
  "feeType": "fixed",
  "feeValue": 10000,
  "user": {
    "identity": "asdf-12-adafafdas-343-adasdfasd"
  },
  "occurredOn": "2017-08-18T13:37:36+00:00",
}
  • accountId (string, required)

  • feeType (enum[string], required)

    • fixed
    • percentage
  • feeValue (number, required)

  • user (object, required)

    • identity (string, required)
  • occurredOn (string, required)

ContactWasCreated

{
  "accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
  "contactId": 5,
  "firstName": "First",
  "lastName": "Name",
  "email": "firstname@email.com",
  "phone": "61459156",
  "position": "CEO",
  "address": "Palm Tree St 123",
  "zipCode": "5544",
  "user": {
    "identity": "asdf-12-adafafdas-343-adasdfasd"
  },
  "occurredOn": "2017-08-18T13:37:36+00:00",
}
  • accountId (string, required)

  • contactId (number, required)

  • firstName (string, required)

  • lastName (string, required)

  • email (string, required)

  • phone (string, required)

  • position (string, required)

  • address (string, required)

  • zipCode (string, required)

  • user (object, required)

    • identity (string, required)
  • occurredOn (string, required)

ContactWasDeleted

{
  "accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
  "contactId": 5,
  "user": {
    "identity": "asdf-12-adafafdas-343-adasdfasd"
  },
  "occurredOn": "2017-08-18T13:37:36+00:00",
}
  • accountId (string, required)

  • contactId (number, required)

  • user (object, required)

    • identity (string, required)
  • occurredOn (string, required)

ContactWasObfuscated

{
  "accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
  "contactId": 5,
  "user": {
    "identity": "asdf-12-adafafdas-343-adasdfasd"
  },
  "occurredOn": "2017-08-18T13:37:36+00:00",
}
  • accountId (string, required)

  • contactId (number, required)

  • user (object, required)

    • identity (string, required)
  • occurredOn (string, required)

ContactWasUpdated

{
  "accountId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeee",
  "contact": {
    "contactId": 5 ,
    "firstName": "First",
    "lastName": "Name",
    "email": "firstname@email.com",
    "phone": "61459156",
    "address": "Palm Tree St 123",
    "zipCode": "5544",
    "position": "CEO",
    "notes": "contact notes" ,
    "deleted": false ,
  }
  "user": {
    "identity": "asdf-12-adafafdas-343-adasdfasd"
  },
  "occurredOn": "2017-08-18T13:37:36+00:00",
}
  • accountId (string, required)

  • contact (object, required)

    • contactId (number, required)
    • firstName (string, required)
    • lastName (string, required)
    • email (string, required)
    • phone (string, required)
    • address (string, required)
    • zipCode (string, required)
    • position (string, required)
    • notes (string, required)
    • deleted (string, bool)
  • user (object, required)

    • identity (string, required)
  • occurredOn (string, required)

Generated by aglio on 27 Nov 2025