Skip to content

Update Integration

PUT
/api/settings/integrations/{integration_id}
curl --request PUT \
--url http://localhost:8000/api/settings/integrations/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "values": { "additionalProperty": "example" } }'

Save credentials for one integration. Blank values are ignored so a saved secret is never clobbered by an empty field.

integration_id
required
Integration Id
string
Media typeapplication/json
IntegrationUpdate
object
values
required
Values
object
key
additional properties
string
Examplegenerated
{
"values": {
"additionalProperty": "example"
}
}

Successful Response

Media typeapplication/json
Examplegenerated
example

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}