Destination connections
Update connection parameters
Update the title and/or connection parameters of an existing destination connection.
connection_params is merged at field level: only the fields present in the payload are updated, omitted fields keep their current values. To change a single setting, send just that field — e.g. {"connection_params": {"partition_by": "by_month"}}.
Notes:
- Unknown field names are rejected with 400.
- Secret fields cannot be updated one at a time — if any secret field is present in the payload, all required secret fields must be sent together. For s3 that means aws_access_key_id, aws_secret_access_key and encryption_key always travel as a trio (keep encryption_key: "stub" unless you use a customer-managed KMS key). Omit secret fields entirely to keep the stored values.
- improvado_assume_role_arn and improvado_assume_role_externalid are managed by Improvado and cannot be changed through this endpoint.
- A successful update resets the connection status and triggers a connection re-check.
See the create endpoint for the full list of connection_params fields per destination.
put/api/v3/destinations/{destination_name}/connections/{id}
Request
- Base URLhttps://embedded.improvado.io
- Auth
- HTTP bearer
- or API key in cookie dts_session_id
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
destination_namestring required
Destination name
idinteger required
Destination Connection ID
Request body
Response
Update a Connection
Changes
No recorded changes to this operation across all 1 revision of this API.