workspace
Update workspace name and/or slug.
Update workspace name and/or slug.
OpenAPI specificationPOST
/api/v1/workspace/updateAuthentication
bearerAuth
Request
curl --globoff --request POST \
--url 'https://honen.com/api/v1/workspace/update' \
--header 'Authorization: Bearer <BEARER_TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{}'Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.
Use the sample JSON body as your starting point, and enter values that match the endpoint's schema.
Parameters
Idempotency-Keyheader · stringUnique retry key. Reusing it with the same body replays the original successful response; different input returns 409.
Request body schema or example
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
}
}
}Responses
200Command result.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
},
"data": {
"type": "object",
"properties": {
"workspace": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string",
"nullable": true
},
"isPersonal": {
"type": "boolean",
"enum": [
false,
true
]
},
"profilePictureKey": {
"type": "string",
"nullable": true
},
"whitelabelEnabled": {
"type": "boolean",
"enum": [
false,
true
]
},
"coursePublishingReviewsEnabled": {
"type": "boolean",
"enum": [
false,
true
]
},
"whitelabelName": {
"type": "string",
"nullable": true
},
"whitelabelLogoKey": {
"type": "string",
"nullable": true
},
"whitelabelFaviconKey": {
"type": "string",
"nullable": true
},
"whitelabelLoginImageKey": {
"type": "string",
"nullable": true
},
"whitelabelLoginMessage": {
"type": "string",
"nullable": true
},
"defaultTimezone": {
"type": "string",
"nullable": true
},
"locale": {
"type": "string",
"nullable": true
},
"terminology": {
"type": "object",
"properties": {
"admin": {
"type": "object",
"properties": {
"singular": {
"type": "string"
},
"plural": {
"type": "string"
},
"Singular": {
"type": "string"
},
"Plural": {
"type": "string"
}
},
"required": [
"singular",
"plural",
"Singular",
"Plural"
]
},
"student": {
"type": "object",
"properties": {
"singular": {
"type": "string"
},
"plural": {
"type": "string"
},
"Singular": {
"type": "string"
},
"Plural": {
"type": "string"
}
},
"required": [
"singular",
"plural",
"Singular",
"Plural"
]
},
"group": {
"type": "object",
"properties": {
"singular": {
"type": "string"
},
"plural": {
"type": "string"
},
"Singular": {
"type": "string"
},
"Plural": {
"type": "string"
}
},
"required": [
"singular",
"plural",
"Singular",
"Plural"
]
},
"workspace": {
"type": "object",
"properties": {
"singular": {
"type": "string"
},
"plural": {
"type": "string"
},
"Singular": {
"type": "string"
},
"Plural": {
"type": "string"
}
},
"required": [
"singular",
"plural",
"Singular",
"Plural"
]
},
"subgroup": {
"type": "object",
"properties": {
"singular": {
"type": "string"
},
"plural": {
"type": "string"
},
"Singular": {
"type": "string"
},
"Plural": {
"type": "string"
}
},
"required": [
"singular",
"plural",
"Singular",
"Plural"
]
},
"member": {
"type": "object",
"properties": {
"singular": {
"type": "string"
},
"plural": {
"type": "string"
},
"Singular": {
"type": "string"
},
"Plural": {
"type": "string"
}
},
"required": [
"singular",
"plural",
"Singular",
"Plural"
]
},
"instructor": {
"type": "object",
"properties": {
"singular": {
"type": "string"
},
"plural": {
"type": "string"
},
"Singular": {
"type": "string"
},
"Plural": {
"type": "string"
}
},
"required": [
"singular",
"plural",
"Singular",
"Plural"
]
},
"organization": {
"type": "object",
"properties": {
"singular": {
"type": "string"
},
"plural": {
"type": "string"
},
"Singular": {
"type": "string"
},
"Plural": {
"type": "string"
}
},
"required": [
"singular",
"plural",
"Singular",
"Plural"
]
},
"curriculum": {
"type": "object",
"properties": {
"singular": {
"type": "string"
},
"plural": {
"type": "string"
},
"Singular": {
"type": "string"
},
"Plural": {
"type": "string"
}
},
"required": [
"singular",
"plural",
"Singular",
"Plural"
]
},
"tag": {
"type": "object",
"properties": {
"singular": {
"type": "string"
},
"plural": {
"type": "string"
},
"Singular": {
"type": "string"
},
"Plural": {
"type": "string"
}
},
"required": [
"singular",
"plural",
"Singular",
"Plural"
]
}
},
"required": [
"admin",
"student",
"group",
"workspace",
"subgroup",
"member",
"instructor",
"organization",
"curriculum",
"tag"
]
}
},
"required": [
"id",
"name",
"slug",
"isPersonal",
"profilePictureKey",
"whitelabelEnabled",
"coursePublishingReviewsEnabled",
"whitelabelName",
"whitelabelLogoKey",
"whitelabelFaviconKey",
"whitelabelLoginImageKey",
"whitelabelLoginMessage",
"defaultTimezone",
"locale",
"terminology"
]
}
},
"required": [
"workspace"
]
}
},
"required": [
"success",
"data"
]
}400Malformed JSON request body.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}401Missing or invalid Connector credentials.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}403Connector policy does not permit this command.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}404Unknown command.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}409Idempotency key is reused, in progress, or belongs to a failed request.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}422Input validation error.
{
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
false
]
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"resolution": {
"type": "string"
},
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"details": {
"nullable": true
}
},
"required": [
"code",
"message",
"resolution"
]
}
},
"required": [
"success",
"error"
]
}