Update installation status

PATCH

https://example.ada.support/api/v2/platform-integrations/:platform_integration_id/installations/:installation_id

PATCH

/api/v2/platform-integrations/:platform_integration_id/installations/:installation_id

1 import requests
2 
3 url = "https://example.ada.support/api/v2/platform-integrations/platform_integration_id/installations/installation_id"
4 
5 payload = {}
6 headers = {
7     "Authorization": "Bearer <token>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.patch(url, json=payload, headers=headers)
12 
13 print(response.json())

1 {
2   "id": "5df263b7db5a7e6ea03fae9b",
3   "platform_integration_id": "5df263b7db5a7e6ea03fae9b",
4   "created": "2020-09-20T00:00:00+00:00",
5   "updated": "2020-09-20T00:00:00+00:00",
6   "configuration": {
7     "credentials": {
8       "helpCenterUrl": "https://example.com",
9       "consumerKey": "123",
10       "consumerSecret": "456"
11     }
12   },
13   "status": "complete"
14 }

Update status after installation. An installation can be complete or incomplete.

Authentication

AuthorizationBearer

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

Path parameters

platform_integration_idstringRequiredformat: "id"

The ID of the platform integration

installation_idstringRequiredformat: "id"

The ID of the installation to update

Request

This endpoint expects an object.

statusenumOptional

The new status of the installation

Response

Installation updated

idstringOptionalformat: "id"

The unique identifier for the integration installation

platform_integration_idstringOptionalformat: "id"

The unique identifier for the integration

createdstringOptionalformat: "date-time"

The date and time the installation was created

updatedstringOptionalformat: "date-time"

The date and time the installation was last updated

configurationobjectOptional

The configuration settings for the integration

statusstringOptional

The current state of the integration installation (incomplete, complete)

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error