Admin

Create an integration

Create an integration

post/v1/admin/integrations/

Request

  • Base URL: https://api.propexo.com
  • URL: https://api.propexo.com/v1/admin/integrations/
  • Auth: HTTP bearer

Request body

integration_vendor'APPFOLIO' | 'BUILDIUM' | 'ENTRATA' | 'MRI' | 'PROPERTYWARE' | 'PROPERTYWARE_REST' | 'REALPAGE' | 'REALPAGE_RPX' | 'RENTMANAGER' | 'RENTVINE' | 'RESMAN' | 'YARDI' | 'YARDI_REST' required

The integration vendor

namestring required

The name of the integration

system'PRODUCTION' | 'SANDBOX'

Deprecated: Do not use

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.

sync_cadence'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'SECOND'

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.

max_request_cadence'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'SECOND'

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

max_request_frequencynumber double

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

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)

activeboolean

The active state of the integration

base_urlstring uri nullable

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.

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.

allow_manual_syncsboolean

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

use_custom_sync_scheduleboolean

Opt-in to use the configured custom_sync_schedule

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.