> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/stackai-mcp/tool-reference/projects-and-workflow-authoring/projects-edit-ui.md).

# projects\_edit\_ui

Merge updates into a draft’s UI options without changing nodes or edges.

**Effect:** This call saves data or changes configuration. Review the behavior below before using it.

## Inputs

| Name         | Type    | Requirement | Description                                                                |
| ------------ | ------- | ----------- | -------------------------------------------------------------------------- |
| `project_id` | string  | Required    | ID returned by `projects_list`; use a project in the active organization.  |
| `updates`    | object  | Required    | Nonempty object of supported interface fields. See supported fields below. |
| `publish`    | boolean | Optional    | Default `false`. Set `true` only to publish the resulting draft.           |

## Supported interface fields

Use `projects_get(version="draft")` to inspect current settings before editing. Common fields include:

| Field                                                           | Type             | Use                                                                                               |
| --------------------------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------- |
| `name`, `description`                                           | string           | Interface title and description.                                                                  |
| `welcome_message`, `input_placeholder_message`, `error_message` | string           | Customer-facing messages.                                                                         |
| `theme`, `font`, `color`, `bg_color`, `font_color`              | string           | Appearance. Preserve an existing valid value when you do not intend to change it.                 |
| `suggested_messages`                                            | array            | Suggested opening messages; retain the existing shape returned by the project.                    |
| `required_inputs`                                               | array of strings | IDs of inputs the interface requires.                                                             |
| `allowed_origin_urls`                                           | array of strings | Website origins permitted to embed the interface.                                                 |
| `website_chatbot_config`, `sso_access`                          | object           | Chatbot placement or access configuration. Read the current object before changing nested values. |

Unknown keys and node-derived fields (`flow_id`, `inputs`, `outputs`, and default-name maps) are rejected. Passwords, API credentials, and Microsoft Teams credentials must be managed in the StackAI interface.

## Example

These are MCP tool arguments, not an HTTP request body. Replace bracketed IDs with values returned from your account.

```json
{
  "project_id": "<project-id>",
  "updates": {
    "welcome_message": "How can I help?",
    "input_placeholder_message": "Enter your question"
  },
  "publish": false
}
```

## Result

Abbreviated result example; unshown fields are omitted for clarity.

```json
{
  "flow_id": "<project-id>",
  "published": false,
  "applied_fields": [
    "welcome_message",
    "input_placeholder_message"
  ],
  "ui_options": {
    "welcome_message": "How can I help?",
    "input_placeholder_message": "Enter your question"
  }
}
```

## Behavior

Read current UI options first and use canonical field names.

Unknown keys and node-derived fields such as inputs, outputs and flow\_id are rejected. publish defaults to false; true attempts publication.

Inspect the returned merged ui\_options and publication result.

## Troubleshooting

Remove unknown or node-derived fields from `updates`. Manage passwords and integration credentials in the StackAI interface. If `publish_error` is present, inspect the saved draft before repeating the edit.

## Related resources

[Projects and workflow authoring](https://docs.stackai.com/stackai-mcp/tool-reference/projects-and-workflow-authoring.md)

[Connection, permissions, pagination, and recovery](https://docs.stackai.com/stackai-mcp/best-practices-and-troubleshooting.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/stackai-mcp/tool-reference/projects-and-workflow-authoring/projects-edit-ui.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
