---
title: Update Space
slug: test-archbee/update-space
docTags: 
createdAt: 2026-02-24T08:46:16.000Z
---

\{
"id": "ajcS0CfeiR57qj2UxaDqd",
"type": "api-oas-v2",
"data": \{
"method": "POST",
"url": "[https://api.archbee.com/api/public-api/space/update](https://api.archbee.com/api/public-api/space/update)",
"servers": \[
\{
"url": "[https://api.archbee.com/api/public-api/space/update](https://api.archbee.com/api/public-api/space/update)",
"description": "Archbee API Server"
}
],
"name": "Update Space",
"description": "Update space fields.",
"contentType": "application/json",
"request": \{
"pathParameters": \[],
"headerParameters": \[
\{
"kind": "required",
"name": "Content-Type",
"type": "string",
"example": "application/json",
"description": ""
}
],
"queryParameters": \[],
"bodyDataParameters": \[
\{
"kind": "required",
"name": "body",
"type": "object",
"description": "",
"schema": \[
\{
"name": "publicAccessControlPart",
"kind": "optional",
"type": "object",
"description": "Configuration for public access control and authentication",
"example": "",
"schema": \[
\{
"name": "publicProtectionType",
"kind": "optional",
"type": "string\<None | Password | Guest accounts | Private Accounts | Private Link | Magic Link | JWT | SAML>",
"description": "Type of protection for the space",
"example": "Password"
},
\{
"name": "publicPassword",
"kind": "optional",
"type": "string",
"description": "Password required when publicProtectionType is 'Password'",
"example": "mySecurePassword123"
},
\{
"name": "publicGuestAccounts",
"kind": "optional",
"type": "array",
"description": "Guest accounts required when publicProtectionType is 'Guest accounts'",
"example": "",
"itemType": "object",
"customType": "object\[]",
"schema": \[
\{
"name": "email",
"kind": "optional",
"type": "string

:::Iframe{code="<email>"}

:::

",
"description": "",
"example": "[guest@example.com](mailto\:guest@example.com)"
},
\{
"name": "password",
"kind": "optional",
"type": "string",
"description": "",
"example": "guestPassword123"
}
]
},
\{
"name": "publicMagicLinkAccounts",
"kind": "optional",
"type": "array",
"description": "Magic link accounts required when publicProtectionType is 'Magic Link'",
"example": "",
"itemType": "object",
"customType": "object\[]",
"schema": \[
\{
"name": "email",
"kind": "optional",
"type": "string

:::Iframe{code="<email>"}

:::

",
"description": "",
"example": "[user@example.com](mailto\:user@example.com)"
}
]
},
\{
"name": "publicPrivateAccounts",
"kind": "optional",
"type": "array",
"description": "Private accounts required when publicProtectionType is 'Private Accounts'",
"example": "",
"itemType": "object",
"customType": "object\[]",
"schema": \[
\{
"name": "email",
"kind": "optional",
"type": "string

:::Iframe{code="<email>"}

:::

",
"description": "",
"example": "[private@example.com](mailto\:private@example.com)"
}
]
},
\{
"name": "privateLinkTokens",
"kind": "optional",
"type": "array",
"description": "Private link tokens required when publicProtectionType is 'Private Link'",
"example": "",
"itemType": "object",
"customType": "object\[]",
"schema": \[
\{
"name": "description",
"kind": "optional",
"type": "string",
"description": "",
"example": "API Access Token"
},
\{
"name": "env",
"kind": "optional",
"type": "string",
"description": "",
"example": "production"
},
\{
"name": "token",
"kind": "optional",
"type": "string",
"description": "",
"example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}
]
},
\{
"name": "jwtValidationType",
"kind": "optional",
"type": "string\<JWT-Secret | JWT-KeySet>",
"description": "JWT validation type required when publicProtectionType is 'JWT'",
"example": "JWT-Secret"
},
\{
"name": "jwtKeyUrl",
"kind": "optional",
"type": "string",
"description": "JWT key URL required when jwtValidationType is 'JWT-KeySet'",
"example": "[https://example.com/.well-known/jwks.json](https://example.com/.well-known/jwks.json)"
},
\{
"name": "jwtSecret",
"kind": "optional",
"type": "string",
"description": "JWT secret required when jwtValidationType is 'JWT-Secret'",
"example": "myJwtSecret123"
},
\{
"name": "conditionalRuleId",
"kind": "optional",
"type": "string",
"description": "Conditional rule ID for advanced access control",
"example": "21-character\_\_string0"
},
\{
"name": "jwtRedirectURL",
"kind": "optional",
"type": "string",
"description": "JWT redirect URL for authentication flow",
"example": "[https://example.com/auth/callback](https://example.com/auth/callback)"
},
\{
"name": "samlMetadata",
"kind": "optional",
"type": "string",
"description": "SAML metadata required when publicProtectionType is 'SAML'",
"example": "

:::Iframe{code="<EntityDescriptor>"}

:::

..."
}
]
},
\{
"name": "hostnamePart",
"kind": "optional",
"type": "object",
"description": "Custom hostname configuration for the space",
"example": "",
"schema": \[
\{
"name": "hostname",
"kind": "optional",
"type": "string",
"description": "Custom hostname for the space",
"example": "docs.example.com"
},
\{
"name": "hostnamePath",
"kind": "optional",
"type": "string",
"description": "Path component for the hostname",
"example": "/api-docs"
}
]
},
\{
"name": "spaceLinks",
"kind": "optional",
"type": "array",
"description": "Links to other spaces. List should start with current space.",
"example": "",
"itemType": "object",
"customType": "object\[]",
"schema": \[
\{
"name": "label",
"kind": "optional",
"type": "string",
"description": "",
"example": "Related Documentation"
},
\{
"name": "docSpaceId",
"kind": "optional",
"type": "string",
"description": "",
"example": "21-character\_\_string0"
}
]
}
],
"isExpanded": true
}
],
"formDataParameters": \[],
"oAuthParameters": \[
\{
"id": "bearerAuth",
"name": "bearerAuth",
"kind": "optional",
"type": "http",
"description": "Requires the&#x20;

:::Iframe{code="<code>"}

:::

Authorization header in the form&#x20;

:::Iframe{code="<code>"}

:::

Authorization: Bearer \{base64(docSpaceId\~apiKey)} Where the token is base64 encoding of docSpaceId, tilde, and apiKey.",
"scheme": "bearer"
}
]
},
"responses": \[
\{
"statusCode": "200",
"description": "Process status",
"jsonExample": "",
"isExpanded": true,
"schema": \[
\{
"kind": "optional",
"type": "object",
"description": "Process status",
"schema": \[
\{
"name": "status",
"kind": "optional",
"type": "string

:::Iframe{code="<OK>"}

:::

",
"description": "Response Status",
"example": ""
},
\{
"name": "data",
"kind": "optional",
"type": "object",
"description": "DocSpace id",
"example": "",
"schema": \[
\{
"name": "id",
"kind": "optional",
"type": "string",
"description": "doc space id",
"example": ""
}
]
}
],
"isExpanded": true
}
]
},
\{
"statusCode": "400",
"description": "Invalid request",
"jsonExample": "",
"isExpanded": true,
"schema": \[
\{
"kind": "optional",
"type": "object",
"description": "",
"customType": "Response400",
"schema": \[
\{
"name": "status",
"kind": "optional",
"type": "string\<OK | Not OK>",
"description": "Response Status",
"example": "Not OK"
},
\{
"name": "messages",
"kind": "optional",
"type": "array",
"description": "Array of messages",
"example": "\["Some error message"]",
"itemType": "string",
"customType": "string\[]",
"itemExample": "Some error message",
"itemDefault": ""
}
],
"modelRef": "#/components/schemas/Response400",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": \{
"languages": \[
\{
"id": "YIYIH5JGaLlnaEZde5Q6T",
"language": "curl",
"label": "cURL",
"code": "curl --request POST \\\n     --url [https://api.archbee.com/api/public-api/space/update](https://api.archbee.com/api/public-api/space/update) \\\n     --header 'accept: application/json'"
},
\{
"id": "WpUla24k3Tjyn1UrlD816",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append("accept", "application/json");\nmyHeaders.append("content-type", "application/json");\n\nvar requestOptions = \{\n   method: 'POST',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch("[https://api.archbee.com/api/public-api/space/update](https://api.archbee.com/api/public-api/space/update)", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
},
\{
"id": "QS70nKICtxrf2e4m3Tj1k",
"language": "ruby",
"label": "Ruby",
"code": "require "uri"\nrequire "json"\nrequire "net/http"\n\nurl = URI("[https://api.archbee.com/api/public-api/space/update")\n\nhttps](https://api.archbee.com/api/public-api/space/update"\)\n\nhttps) = Net\::HTTP.new(url.host, url.port)\nhttps.use\_ssl = true\n\nrequest = Net\::HTTP\::Post.new(url)\nrequest\["accept"] = "application/json"\nrequest\["content-type"] = "application/json"\n\nresponse = https.request(request)\nputs response.read\_body\n"
},
\{
"id": "zclSlozxr\_-oORnM0-QDC",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = "[https://api.archbee.com/api/public-api/space/update"\n\npayload](https://api.archbee.com/api/public-api/space/update"\n\npayload) = \{}\nheaders = \{\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request("POST", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "YIYIH5JGaLlnaEZde5Q6T"
},
"results": \{
"languages": \[
\{
"id": "aYEDYeiBh2U9mjiqp7mrT",
"language": "200",
"code": "// Process status\n\{\n  "status": "",\n  "data": \{\n    "id": ""\n  }\n}"
},
\{
"id": "YIKuRWTnhHwI2ybNWP34y",
"language": "400",
"code": "// Invalid request\n\{\n  "status": "Not OK",\n  "messages": \[\n    "Some error message"\n  ]\n}"
}
],
"selectedLanguageId": "aYEDYeiBh2U9mjiqp7mrT"
}
},
"children": \[
\{
"text": ""
}
]
}