Update an integration | Propexo

curl -X PUT https://api.propexo.com/v1/admin/integrations/integration_id/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "result": {
    "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
    "created_at": "2024-05-01T08:30:00Z",
    "updated_at": "2024-06-01T12:45:00Z",
    "name": "AppFolio Integration",
    "integration_vendor": "APPFOLIO",
    "active": true,
    "system": "PRODUCTION",
    "is_archived": false,
    "new_properties_are_enabled": true,
    "sync_frequency": 15,
    "sync_cadence": "MINUTE",
    "base_url": "https://api.appfolio.com/v1",
    "max_request_cadence": "SECOND",
    "max_request_frequency": 10,
    "max_job_concurrency": 5,
    "custom_sync_schedule": {
      "type": "WEEK_BASED",
      "timezone": "UTC",
      "interval": {
        "SUNDAY": {
          "slots": [
            {
              "start": "08:00",
              "end": "12:00",
              "sync_frequency": 15,
              "sync_cadence": "MINUTE"
            }
          ]
        },
        "MONDAY": {
          "slots": [
            {
              "start": "09:00",
              "end": "17:00",
              "sync_frequency": 30,
              "sync_cadence": "MINUTE"
            }
          ]
        },
        "TUESDAY": {
          "slots": [
            {
              "start": "09:00",
              "end": "17:00",
              "sync_frequency": 30,
              "sync_cadence": "MINUTE"
            }
          ]
        },
        "WEDNESDAY": {
          "slots": [
            {
              "start": "09:00",
              "end": "17:00",
              "sync_frequency": 30,
              "sync_cadence": "MINUTE"
            }
          ]
        },
        "THURSDAY": {
          "slots": [
            {
              "start": "09:00",
              "end": "17:00",
              "sync_frequency": 30,
              "sync_cadence": "MINUTE"
            }
          ]
        },
        "FRIDAY": {
          "slots": [
            {
              "start": "09:00",
              "end": "17:00",
              "sync_frequency": 30,
              "sync_cadence": "MINUTE"
            }
          ]
        },
        "SATURDAY": {
          "slots": [
            {
              "start": "10:00",
              "end": "14:00",
              "sync_frequency": 60,
              "sync_cadence": "MINUTE"
            }
          ]
        }
      }
    },
    "use_custom_sync_schedule": true,
    "allow_manual_syncs": true
  }
}

Update an integration

Authentication

AuthorizationBearer

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

Path parameters

integration_idstringRequired

The ID of the resource.

Request

This endpoint expects an object.

integration_vendorenumOptional

The integration vendor

credentialsmap from strings to any or objectOptional

JSON encoded credentials for accessing the integration vendor API

namestringOptional

The name of the integration

sync_frequencyintegerOptional

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_cadenceenumOptional

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_cadenceenumOptionalDefaults to 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_frequencydoubleOptional>=1Defaults to 1

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_concurrencyintegerOptional1-100Defaults to 1

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

activebooleanOptional

The active state of the integration

new_properties_are_enabledbooleanOptional

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

custom_sync_scheduleobjectOptional

A custom sync schedule configuration object

use_custom_sync_schedulebooleanOptional

Opt-in to use the configured custom_sync_schedule

systemenumOptionalDeprecated

Deprecated: Do not use.

Allowed values:

base_urlstring or nullOptionalformat: "uri"Deprecated

DEPRECATED. See specific PMS credentials for usage.

allow_manual_syncsbooleanOptionalDefaults to trueDeprecated

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

Response

Successful response

resultobject

Authentication

Path parameters

Request

Response

Errors