Integrations
Update an integration
Rename an integration, or replace its keys.
How it works
If you send keys, send all of them: they replace the saved set. Ollive checks the new keys with the platform before saving them.
Request body
application/json
- idstring (uuid)required
The integration’s ID.
- namestringup to 255 characters
A new name.
- keysobject
The full set of keys. Replaces the saved ones.
Response
The updated integration.
- idstring (uuid)required
The integration’s ID.
- typestringrequired
The platform type, such as
RETELL. - kindstringrequired
What kind of platform it is.
agent_platformagent_observabilityalert_and_workflow - namestringrequired
The name you gave it.
- keysobject[]required
The keys saved on this integration. Secret values are never shown, only whether they are set.
- namestringrequired
The key’s name.
- is_secretbooleanrequired
Whether the value is secret.
- is_setbooleanrequired
Whether a value is saved.
- valuestringrequired
The saved value. Always empty for secret keys.
- created_atstring (date-time)required
When it was connected.
- updated_atstring (date-time)required
When it was last changed.
- last_synced_atstring (date-time)
When Ollive last read the agents on this platform. Missing until the first read.
Something in the request is wrong. code and param tell you what.
Returns an error, for example with the code invalid_request.
The API key is missing, wrong, revoked or expired.
Returns an error, for example with the code authentication_failed.
We couldn’t find that item in your account.
Returns an error, for example with the code not_found.
That name is already in use in your account.
Returns an error, for example with the code duplicate_name.
The platform rejected these keys. Nothing was saved.
Returns an error, for example with the code connection_test_failed.