Update an integration

Path parameters

integration_idstringRequired

The ID of the resource.

Request

This endpoint expects an object.

integration_vendorenumOptional

The integration vendor

credentialsobjectOptional

JSON encoded credentials for accessing the integration vendor API

namestringOptional

The name of the integration

system"PRODUCTION" or "SANDBOX"Optional

Allowed values: PRODUCTIONSANDBOX

Deprecated: Do not use.

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_frequencydoubleOptionalDefaults 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_concurrencyintegerOptionalDefaults 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

base_urlstringOptional

DEPRECATED. See specific PMS credentials for usage.

new_properties_are_enabledbooleanOptional

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

allow_manual_syncsbooleanOptional

Whether or not manual syncs are allowed to be triggered on this integration

custom_sync_scheduleobjectOptional

A custom sync schedule configuration object

use_custom_sync_schedulebooleanOptional

Opt-in to use the configured custom_sync_schedule

Response

This endpoint returns an object.

resultobject

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

1	{
2	"result": {
3	"id": "id",
4	"created_at": "created_at",
5	"updated_at": "updated_at",
6	"integration_vendor": "SAMPLE2",
7	"active": true,
8	"system": "PRODUCTION",
9	"is_archived": true,
10	"new_properties_are_enabled": true,
11	"allow_manual_syncs": true,
12	"name": "name",
13	"sync_frequency": 1,
14	"sync_cadence": "MINUTE",
15	"max_request_cadence": "MINUTE",
16	"max_request_frequency": 10,
17	"max_job_concurrency": 1,
18	"custom_sync_schedule": {
19	"type": "WEEK_BASED",
20	"timezone": "UTC",
21	"interval": {}
22	},
23	"use_custom_sync_schedule": true,
24	"base_url": "base_url"
25	}
26	}

Path parameters

Request

Response

Errors