--- title: Create MessageBundle slug: api-documentation/create-messagebundle docTags: createdAt: 2026-08-27T16:56:53.565Z --- { "id": "vAFjfbwtOcv5UYh7y1erG", "type": "api-oas-v2", "data": { "method": "POST", "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": "Create MessageBundle", "description": "

This endpoint creates a new message bundle.

\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": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-upstart-tenant", "type": "string", "description": "Tenant identifier associated with the site this call is for." } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "CreateOrUpdateMessageBundle", "schema": [ { "name": "message", "kind": "required", "type": "string", "description": "Message." } ], "modelRef": "#/components/schemas/CreateOrUpdateMessageBundle", "isExpanded": true } ], "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": "201", "description": "

Success–message bundle created successfully.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "MessageBundle", "schema": [ { "name": "category", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/BundleCategory", "customType": "BundleCategory", "schema": [] }, { "name": "locale", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/BundleLocale", "customType": "BundleLocale", "schema": [] }, { "name": "key", "kind": "required", "type": "string", "description": "", "modelRef": "#/components/schemas/BundleKey", "customType": "BundleKey", "schema": [] }, { "name": "message", "kind": "required", "type": "string", "description": "Message." } ], "modelRef": "#/components/schemas/MessageBundle", "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": "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": "jccUQOr-ZCewLb6SCXwTL", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url //v1/message-bundles/{category}/{locale}/{key} \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '{\n \"message\": \"\"\n }'" }, { "id": "u4PSr7NBe0X_8yV4On8Q-", "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 raw = JSON.stringify({\n \"message\": \"\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\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": "ihJ6FMYCK2ppNJzVUwVau", "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::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n \"message\": \"\"\n})\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "LzMTZDbm-7hegSJhmWQnr", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"//v1/message-bundles/{category}/{locale}/{key}\"\n\npayload = json.dumps({\n \"message\": \"\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "jccUQOr-ZCewLb6SCXwTL" }, "results": { "languages": [ { "id": "XLDMPX_O66z40jTFiRoVr", "language": "201", "code": "// Success–message bundle created successfully.\n{\n \"category\": \"\",\n \"locale\": \"\",\n \"key\": \"\",\n \"message\": \"\"\n}" }, { "id": "mqFPr9UaKM4Zwzu8wIVf4", "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": "3wWviVZF1B5f2xAcVYSIx", "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": "P1b_5dWNuFdk_GkgzJ3Yz", "language": "500", "code": "// Internal server error.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "XLDMPX_O66z40jTFiRoVr" } }, "children": [ { "text": "" } ] }