--- title: Delete MessageBundle by key slug: api-documentation/delete-messagebundle-by-key docTags: createdAt: 2026-08-27T16:56:53.565Z --- { "id": "ddrmrdURcqv3It1ERmNah", "type": "api-oas-v2", "data": { "method": "DELETE", "url": "//v1/message-bundles/{category}/{locale}/{key}", "servers": [ { "url": "//v1/message-bundles/{category}/{locale}/{key}" }, { "url": "https://api.upstartcommerce.com//v1/message-bundles/{category}/{locale}/{key}" } ], "name": "Delete MessageBundle by key", "description": "

This endpoint deletes a message bundle making all of its associated data inaccessible.

\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "category", "type": "string", "description": "Unique identifier for a message bundle category." }, { "kind": "required", "name": "locale", "type": "string", "description": "Unique identifier for a message bundle locale." }, { "kind": "required", "name": "key", "type": "string", "description": "Unique identifier for a message bundle." } ], "headerParameters": [ { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "NoChannelPortalAccess", "name": "NoChannelPortalAccess", "kind": "optional", "type": "http", "description": "

This authentication is required for clients to interact with any of the management APIs. Similar to 'LoggedIn', it indicates that the user has actually logged into the system, but in this case with a management role.

", "scheme": "bearer" }, { "id": "ApiKey", "name": "X-UpStart-API-Key", "kind": "optional", "type": "apiKey", "in": "header" }, { "id": "Session", "name": "X-UpStart-Session-Id", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Success–message bundle deleted.

", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "The request contained information that the server was unable to process. Appropriate errors are provided in the response body.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ValidationErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ValidationErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "404", "description": "The requested resource was not found in the NoChannel system.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal server error.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "code", "kind": "required", "type": "string", "description": "" }, { "name": "detail", "kind": "required", "type": "string", "description": "" }, { "name": "reason", "kind": "optional", "type": "string", "description": "" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "VGcV4_g1hwzdqYyRYjbb0", "language": "curl", "label": "cURL", "code": "curl --request DELETE \\\n --url //v1/message-bundles/{category}/{locale}/{key} \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "wTVqNn_Rrl7WYIB1B9sdF", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar requestOptions = {\n method: 'DELETE',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"//v1/message-bundles/{category}/{locale}/{key}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "kt6BnVtDiQYH4bv83sFvk", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"//v1/message-bundles/{category}/{locale}/{key}\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Delete.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "M9LlRMkKk2P1qbwz9vSQl", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"//v1/message-bundles/{category}/{locale}/{key}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "VGcV4_g1hwzdqYyRYjbb0" }, "results": { "languages": [ { "id": "3CoCxP_icQkRcqfe1qr0P", "language": "200", "code": "// Success–message bundle deleted.\n" }, { "id": "qEDF5qBFcK5fn9jemOG3f", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "2GdiqTUwk-6mGjXX5He5i", "language": "401", "code": "// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "w1ogHHOZk06CzFaNkeQz_", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "jO5C4rD7yZwIaV4j4llqO", "language": "500", "code": "// Internal server error.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "3CoCxP_icQkRcqfe1qr0P" } }, "children": [ { "text": "" } ] }