Configuration APIsAdmin

Update an integration

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 associated with the data diff
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

Errors