---
title: "Edit Connection"
method: POST
path: "/poweredby/connection/edit/{connectionId}"
tags: ["Connection"]
---

# Edit Connection

`POST /poweredby/connection/edit/{connectionId}`

Edit Connection edits a connection in the Connect AI Embed product. Returns a string containing the URL to redirect the user to.

## Path parameters

- `connectionId` string, required

## Request body

- EditConnectionRequest
  - `redirectURL` string, required — The URL to redirect the customer once the customer has edited the connection through the Connect AI UI. This URL maps to the **Return to** button on the **Edit Connection** page in the Connect AI UI.
  - `name` string, nullable — (Optional) If provided, the connection name. By default, this is a suggested default that the end user can change on the **Edit Connection** form. Set `editableName` to `false` to lock the field and enforce the supplied value server-side.
  - `editableName` boolean — (Optional) The default value is `true`. When `true`, any `name` you supply is shown as a suggested default value, and the end user can change it. When `false`, the **Connection Name** field is rendered read-only, and the server enforces the supplied `name` on submit. Has no effect when `name` is omitted.

## Response `200`

A string containing the CData-hosted connection URL to redirect the user to.

- RedirectURLResponse
  - `redirectURL` string, required — A string containing the CData-hosted connection URL to redirect the user to.

---

[API](https://skmtc.net/cdata/apis/cdata-connect-ai-rest-api-embedded.md) · [All operations](https://skmtc.net/cdata/apis/cdata-connect-ai-rest-api-embedded/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cdata/cdata-connect-ai-rest-api-embedded/versions/c13133ad66c0/schema)