> For the complete documentation index, see [llms.txt](https://compassly.gitbook.io/compassly-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://compassly.gitbook.io/compassly-docs/core-modules/program-library/subdomains/edit-subdomain.md).

# Edit Subdomain

**Page type:** Task guide\
**Status:** Draft (Noah Edit)\
**Owner:** Documentation Team\
**Last verified:** 2026-04-02 (Noah Edit: 2026-04-23)\
**Audience:** Super Admin

## What This Section Covers

This material covers how to update an existing subdomain record.

## Before You Start

* You must have permission "View subdomain list".
* You must have permission "Edit subdomain".
* Depending on your role, you may see only be able to acces the View Details page OR the Edit Details page.

## Where To Start

1. Sign in to Compassly.
2. In the left navigation menu, select ***Program Library***.
3. In the left navigation menu, select ***Subdomains*** from the dropdown menu under ***Program Library***.

## Available Actions

1. **Open the Edit subdomain page.**
   * You may want to use the filters covered in "View Subdomain List" guide to narrow your list data.
   * You can either select the item by clicking on the item's row in the list, or by opening the Action dropdown menu (click the three dots on the right under the Action column) and selecting "Edit subdomain".

![](/files/IpqSA7ZmFqJhO6IyKXLt)\
*Figure 1. Subdomain List page with emphasis on edit navigation.*

2. **Alter *****Subdomain***** field.**
   * Once on the "Edit subdomain" page, you should see a standard text field with the name of the Subdomain that you are attempting to edit. Simply click into the field in order to start editing. There are no character length or type limits. The only restriction is that there has to be something in the field in order to save.

![](/files/0sEQ29KwxNncQA7Gt0uP)\
*Figure 2. Edit subdomain page overview with emphasis on edit options.*

3. **Save Changes to Subdomain.**
   * Once all your alterations are complete, select the "Update" button at the bottom of the form to save your changes. A success notifcation should appear at the bottom left corner of your screen.

![](/files/GgCOW2g6iWT3tnmsB35M)\
*Figure 3. Success notification for saving changes to a Subdomain.*

4. **Use the "Cancel" button to exit back to the Subdomain List without saving.**
   * If a change is made to the Subdomain details, clicking the "Cancel" button will generate a dialog box to confirm that you want to back out without saving your changes.
   * Hitting the cancel button when no changes have been made will also not trigger the dialog box for confirmation.

![](/files/WrTasFHRtZP4UV67QhVS)\
*Figure 4. The dialog box that pops up when you try to back out of an edit without saving changes.*

## Role Differences

* ***Super Admin:*** Will be able to edit details for Subdomains.
* ***Admin / Supervisor / Clinician / Basic:*** Does not have access to edit Subdomains.

## Summary Of Section

**Upon reviewing this material, you should be able to:**

* Navigate to the "Edit subdomain" page
* Alter the *Subdomain* name field
* Save changes to a Subdomain
* Back out of editing a Subdomain without saving changes using the "Cancel" button

## Related Guides

* [View Subdomain Details](/compassly-docs/core-modules/program-library/subdomains/view-subdomain-details.md)
* [View Subdomain List](/compassly-docs/core-modules/program-library/subdomains/view-subdomain-list.md)
* [Delete Subdomain](/compassly-docs/core-modules/program-library/subdomains/delete-subdomain.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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://compassly.gitbook.io/compassly-docs/core-modules/program-library/subdomains/edit-subdomain.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.