Update Namespace

Update the properties of an existing namespace including name, color theme, and client terminology.

---

Overview

This endpoint allows administrators to modify the properties of a namespace. The namespace must exist, and the requester must have admin privileges.

Method: PATCH
Endpoint:
/api/v1/namespaces/{namespaceId}

Requires administrator authentication with valid token.

---

Request

Headers

x-api-key: {your_api_key}  # Required
Content-Type: application/json

Path Parameters

Parameter	Type	Required	Description
namespaceId	string	✅	ID of the namespace to be updated

Body Parameters

Field	Type	Required	Description
name	string	❌	Display name of the namespace
primaryColor	string	❌	Hex color code for the namespace theme
clientTerm	string	❌	Term for users, usually "client/member/user". Can be an empty string
showSampleQuizzes	boolean	❌	Whether to display sample quizzes in the namespace
isEnzCtaEnabled	boolean	❌	Toggles wheter the email, name, and zipcode information appear as params in the call-to-action clicks feature

---

Example Request Body

{
  "name": "Updated Namespace Name",
  "primaryColor": "#ff5500",
  "clientTerm": "members",
  "showSampleQuizzes": true,
  "isEnzCtaEnabled": false,
}

Response

Success Response

{
  "namespace": {
    "id": "api-testing-env",
    "name": "Updated Namespace Name",
    "primaryColor": "#ff5500",
    "clientTerm": "members",
    "showSampleQuizzes": true,
    "isEnzCtaEnabled": false,
    "logoUrl": "https://storage.googleapis.com/fhc-dev-files/api-testing-env/logo.png",
    "tennantId": "api-testing-env-q2px9",
    "namespaceType": "internal"
  }
}

---

Notes

• You can update one or more properties in a single request.
• The namespace must exist before it can be updated.