Update integration module configuration
PATCH/homes/{homeId}/intmods/{configId}
Base URL: https://api.tinkermode.com
Update specified integration module configuration
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain the API key of a user or service account who has the permission to update all integration module configurations of a home, or a Project API Key with admin permission.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
homeId | integer | Yes | The unique ID for a specified home. | |
configId | string | Yes | Integration Module Configuration ID |
Request body
Content type: application/json
| Property | Type | Required | Constraints | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
catalogType | string | Yes | Catalog type of the integration module. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
claims | object | No | Claims is the definition of the authentication method and credentials for the integration module. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
configId | string | Yes | read-only (server-generated) | Unique Integration Module ID. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
homeId | integer | Yes | Home that this integration module belongs to. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
projectId | integer | Yes | read-only (server-generated) | Project that this integration module belongs to. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
schedule | object | No | Schedule is the definition of the schedule for the integration module. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request example
{
"attributes": {
"attribute 1": "Value of the attribute 1",
"attribute 2": "Value of the attribute 2"
},
"catalogType": "external-service",
"claims": {
"credentials": {
"grantType": "client_credentials",
"tokenUrl": "https://auth.example.com/oauth2/token"
},
"method": "oauth2"
},
"configId": "external-service-1234",
"homeId": 1234,
"projectId": 1234,
"schedule": {
"cronSchedule": "* * * * *",
"cronTimeZone": "Asia/Tokyo",
"operations": [
{
"appConfigs": {
"defaultAttributeValues": {
"userId": "external_service_user_5678"
}
},
"operationName": "users",
"parameters": [
{
"name": "user_id",
"value": "5678"
}
]
}
]
}
}Responses
204 Successfully updated integration module configuration.
401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 Request failed because of invalid data or denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
404 The requested intmod does not exist or is not accessible.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |