Create an integration

POSThttps://api.propexo.com/v1/admin/integrations/

Authentication

• AuthorizationBearer
  Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

integration_vendorEnum9required
The integration vendor
Show 13 enum values
APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
credentials objectrequired
JSON encoded credentials for accessing the integration vendor API
anyOf
• object
• Entrata
• MRI
• Propertyware REST
• RealpageRegisteredVendor
• Propertyware SOAP
• RentManagerSandbox
• RentManagerProduction
• Buildium
• Resman
• AppFolio
• RealpagePartnerExchange
• EliseAI
• Knock
• Rentvine
• Yardi
• Yardi REST
object
namestringrequired

The name of the integration

systemstringdeprecated
Deprecated: Do not use
Show 2 enum values
PRODUCTIONSANDBOX
sync_frequencyinteger
The interval of the scheduled sync frequency. (e.g. "12" in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.
Possible values: >= 1
Default value: 12
sync_cadencestring
The cadence of the scheduled sync frequency. (e.g. "HOUR" in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.
Show 6 enum values
MINUTEHOURDAYWEEKMONTHSECOND
Default value: HOUR
max_request_cadencestring
The cadence at which to limit the max request frequency. (e.g. "SECOND" in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute
Show 6 enum values
MINUTEHOURDAYWEEKMONTHSECOND
Default value: SECOND
Example: SECOND
max_request_frequencynumber
The maximum number of requests sent to the PMS API per cadence unit. (e.g. "2" in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute
Possible values: >= 1
Default value: 1
Example: 1
max_job_concurrencyinteger
Maximum number of jobs that can be run at once for the integration. (e.g. "1" in the following: 1 request per 2 SECONDs)
Possible values: >= 1 and <= 100
Default value: 1
Example: 1
activeboolean
The active state of the integration
Default value: false
base_url(string | null)<uri>nullabledeprecated

DEPRECATED. See specific PMS credentials for usage.

new_properties_are_enabledboolean
Whether or not properties need to be approved before by you ingesting data for them.
Default value: true
based_on_integration_idstring
A reference integration_id to base the creation of an integration on. This includes copying job scheduling frequency and similar configuration. Credentials are not copied and must still be provided.
Example: clwsc909e000008l73rix7mae
allow_manual_syncsbooleandeprecated
Deprecated: This is no longer configurable and will always be true
Default value: true
custom_sync_schedule object
A custom sync schedule configuration object which will be respected if use_custom_schedule is set to true
typestringrequired
Show 1 enum value
WEEK_BASED
timezonestringrequired
Show 8 enum values
UTCAmerica/New_YorkAmerica/ChicagoAmerica/DenverAmerica/PhoenixAmerica/Los_AngelesAmerica/AnchoragePacific/Honolulu
interval objectrequired
SUNDAY object
slots object[]required
Array [
startstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
endstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
sync_frequencyintegerrequired
Possible values: > 0
sync_cadencestringrequired
Show 6 enum values
MINUTEHOURDAYWEEKMONTHSECOND
]
MONDAY object
slots object[]required
Array [
startstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
endstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
sync_frequencyintegerrequired
Possible values: > 0
sync_cadencestringrequired
Show 6 enum values
MINUTEHOURDAYWEEKMONTHSECOND
]
TUESDAY object
slots object[]required
Array [
startstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
endstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
sync_frequencyintegerrequired
Possible values: > 0
sync_cadencestringrequired
Show 6 enum values
MINUTEHOURDAYWEEKMONTHSECOND
]
WEDNESDAY object
slots object[]required
Array [
startstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
endstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
sync_frequencyintegerrequired
Possible values: > 0
sync_cadencestringrequired
Show 6 enum values
MINUTEHOURDAYWEEKMONTHSECOND
]
THURSDAY object
slots object[]required
Array [
startstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
endstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
sync_frequencyintegerrequired
Possible values: > 0
sync_cadencestringrequired
Show 6 enum values
MINUTEHOURDAYWEEKMONTHSECOND
]
FRIDAY object
slots object[]required
Array [
startstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
endstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
sync_frequencyintegerrequired
Possible values: > 0
sync_cadencestringrequired
Show 6 enum values
MINUTEHOURDAYWEEKMONTHSECOND
]
SATURDAY object
slots object[]required
Array [
startstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
endstringrequired
Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)
sync_frequencyintegerrequired
Possible values: > 0
sync_cadencestringrequired
Show 6 enum values
MINUTEHOURDAYWEEKMONTHSECOND
]
use_custom_sync_scheduleboolean
Opt-in to use the configured custom_sync_schedule
Default value: false

Response

Successful response

result objectrequired

idstringrequired

The unique identifier for the integration

created_atstringrequired

The date the integration was created

updated_atstringrequired

The date the integration was last updated

namestring | nullnullablerequired

The name of the integration

vendorstringrequired

The property management system of record

Show 17 enum values

APPFOLIOBUILDIUMELISEAIENTRATAFUNNELKNOCKMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTCAFERENTMANAGERRENTVINERESMANYARDIYARDI_REST

activebooleanrequired

The active state of the integration

systemstringrequired

The system the integration is associated with

Show 2 enum values

PRODUCTIONSANDBOX

sync_frequencyintegerrequired

The interval of the scheduled sync frequency. (e.g. "12" in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.

sync_cadencestringrequired

The cadence of the scheduled sync frequency. (e.g. "HOUR" in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.

Show 6 enum values

MINUTEHOURDAYWEEKMONTHSECOND

max_request_cadencestring

The cadence at which to limit the max request frequency. (e.g. "SECOND" in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute

Show 6 enum values

MINUTEHOURDAYWEEKMONTHSECOND

Default value: SECOND

Example: SECOND

max_request_frequencynumber

The maximum number of requests sent to the PMS API per cadence unit. (e.g. "2" in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute

Possible values: >= 1

Default value: 1

Example: 10

max_job_concurrencyinteger

Maximum number of jobs that can be run at once for the integration. (e.g. "1" in the following: 1 request per 2 SECONDs)

Possible values: >= 1

Default value: 1

Example: 1

base_urlstring | nullnullablerequireddeprecated

DEPRECATED: see specific PMS credentials. Base URL for the integration vendor API

customer_idstringrequired

The unique identifier for the customer

is_archivedbooleanrequired

Whether or not the integration is archived

ping_results objectrequired

property name*string

new_properties_are_enabledbooleanrequired

Whether or not properties need to be approved before ingesting data for them.

allow_manual_syncsbooleandeprecated

Deprecated: This is no longer configurable and will always be true

Default value: true

custom_sync_schedule object

typestringrequired

Show 1 enum value

WEEK_BASED

timezonestringrequired

Show 8 enum values

UTCAmerica/New_YorkAmerica/ChicagoAmerica/DenverAmerica/PhoenixAmerica/Los_AngelesAmerica/AnchoragePacific/Honolulu

interval objectrequired

SUNDAY object

slots object[]required

Array [

startstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

endstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

sync_frequencyintegerrequired

Possible values: > 0

sync_cadencestringrequired

Show 6 enum values

MINUTEHOURDAYWEEKMONTHSECOND

]

MONDAY object

slots object[]required

Array [

startstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

endstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

sync_frequencyintegerrequired

Possible values: > 0

sync_cadencestringrequired

Show 6 enum values

MINUTEHOURDAYWEEKMONTHSECOND

]

TUESDAY object

slots object[]required

Array [

startstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

endstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

sync_frequencyintegerrequired

Possible values: > 0

sync_cadencestringrequired

Show 6 enum values

MINUTEHOURDAYWEEKMONTHSECOND

]

WEDNESDAY object

slots object[]required

Array [

startstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

endstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

sync_frequencyintegerrequired

Possible values: > 0

sync_cadencestringrequired

Show 6 enum values

MINUTEHOURDAYWEEKMONTHSECOND

]

THURSDAY object

slots object[]required

Array [

startstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

endstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

sync_frequencyintegerrequired

Possible values: > 0

sync_cadencestringrequired

Show 6 enum values

MINUTEHOURDAYWEEKMONTHSECOND

]

FRIDAY object

slots object[]required

Array [

startstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

endstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

sync_frequencyintegerrequired

Possible values: > 0

sync_cadencestringrequired

Show 6 enum values

MINUTEHOURDAYWEEKMONTHSECOND

]

SATURDAY object

slots object[]required

Array [

startstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

endstringrequired

Possible values: Value must match regular expression (?:[01]\d|2[0123]):(?:[012345]\d)

sync_frequencyintegerrequired

Possible values: > 0

sync_cadencestringrequired

Show 6 enum values

MINUTEHOURDAYWEEKMONTHSECOND

]

use_custom_sync_schedulebooleanrequired

Opt-in to use the configured custom_sync_schedule

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

POST /v1/admin/integrations/

curl -X POST https://api.propexo.com/v1/admin/integrations/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_vendor": "APPFOLIO",
  "credentials": {},
  "name": "string"
}'

200 Successful response

{
  "result": {
    "id": "string",
    "created_at": "string",
    "updated_at": "string",
    "name": "string",
    "vendor": "APPFOLIO",
    "active": true,
    "system": "PRODUCTION",
    "sync_frequency": 0,
    "sync_cadence": "MINUTE",
    "max_request_cadence": "SECOND",
    "max_request_frequency": 10,
    "max_job_concurrency": 1,
    "customer_id": "string",
    "is_archived": true,
    "ping_results": {},
    "new_properties_are_enabled": true,
    "custom_sync_schedule": {
      "type": "WEEK_BASED",
      "timezone": "UTC",
      "interval": {
        "SUNDAY": {
          "slots": [
            {
              "start": "string",
              "end": "string",
              "sync_frequency": 0,
              "sync_cadence": "MINUTE"
            }
          ]
        },
        "MONDAY": {
          "slots": [
            {
              "start": "string",
              "end": "string",
              "sync_frequency": 0,
              "sync_cadence": "MINUTE"
            }
          ]
        },
        "TUESDAY": {
          "slots": [
            {
              "start": "string",
              "end": "string",
              "sync_frequency": 0,
              "sync_cadence": "MINUTE"
            }
          ]
        },
        "WEDNESDAY": {
          "slots": [
            {
              "start": "string",
              "end": "string",
              "sync_frequency": 0,
              "sync_cadence": "MINUTE"
            }
          ]
        },
        "THURSDAY": {
          "slots": [
            {
              "start": "string",
              "end": "string",
              "sync_frequency": 0,
              "sync_cadence": "MINUTE"
            }
          ]
        },
        "FRIDAY": {
          "slots": [
            {
              "start": "string",
              "end": "string",
              "sync_frequency": 0,
              "sync_cadence": "MINUTE"
            }
          ]
        },
        "SATURDAY": {
          "slots": [
            {
              "start": "string",
              "end": "string",
              "sync_frequency": 0,
              "sync_cadence": "MINUTE"
            }
          ]
        }
      }
    },
    "use_custom_sync_schedule": true
  }
}