Admin

Update an integration

PUT
Update an integration

Path parameters

integration_idstringRequired

Request

This endpoint expects an object.
integration_vendor
enumOptional
The integration vendor
credentials
unionOptional
JSON encoded credentials for accessing the integration vendor API
name
stringOptional
The name of the integration
system
enumOptional
Deprecated: Do not use.
Allowed values: PRODUCTIONSANDBOX
sync_frequency
integerOptional
The interval of the scheduled sync frequency. (e.g. "12" in the following: Sync every 12 HOURs)
sync_cadence
enumOptional
The cadence of the scheduled sync frequency. (e.g. "HOUR" in the following: Sync every 12 HOURs)
max_request_cadence
enumOptional
The cadence at which to limit the max request frequency. (e.g. "SECOND" in the following: 1 request per 2 SECONDs)
max_request_frequency
doubleOptionalDefaults 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)
max_job_concurrency
integerOptionalDefaults 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) — Please contact support to increase this limit.
active
booleanOptional
The active state of the integration
base_url
stringOptional
DEPRECATED. See specific PMS credentials for usage.
new_properties_are_enabled
booleanOptional
Whether or not properties need to be approved before ingesting data for them.
allow_manual_syncs
booleanOptional
Whether or not manual syncs are allowed to be triggered on this integration

Response

This endpoint returns an object
result
object
PUT
1curl -X PUT https://api.propexo.com/v1/admin/integrations/clwh5u07w000508me66sfh3um \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Updated
1{
2 "result": {
3 "id": "clwktsp9v000008l31iv218hn",
4 "created_at": "2024-03-21T15:38:08.337Z",
5 "updated_at": "2024-03-22T10:59:45.119Z",
6 "integration_vendor": "BUILDIUM",
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 "base_url": "base_url"
19 }
20}