--- title: Get MessageBundle Config slug: api-documentation/get-messagebundle-config docTags: createdAt: 2026-08-27T16:56:53.565Z --- { "id": "c0WwNJGP_7ucl3s-ka25Y", "type": "api-oas-v2", "data": { "method": "GET", "url": "//internal/v1/message-bundles/config", "servers": [ { "url": "//internal/v1/message-bundles/config" }, { "url": "https://api.upstartcommerce.com//internal/v1/message-bundles/config" } ], "name": "Get MessageBundle Config", "description": "

This endpoint returns service configuration object.

\n

Authorized roles:

\n\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [], "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": [], "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 – configuration object returned.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [], "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": "4kc4UEmRTWJYu9QE6kE8K", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url //internal/v1/message-bundles/config \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "xuYESHOeY0ZUiNJUm728Y", "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: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"//internal/v1/message-bundles/config\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "AIpTq-czsE-CP4boD94E2", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"//internal/v1/message-bundles/config\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.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": "eSTnSrM2fxio9Rzn3dKZI", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"//internal/v1/message-bundles/config\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "4kc4UEmRTWJYu9QE6kE8K" }, "results": { "languages": [ { "id": "MXMcN3yYVXpA3H3bARJlK", "language": "200", "code": "// Success – configuration object returned.\n{}" }, { "id": "lksCDx_mgMIK6TOGO2AFj", "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": "CNkphXZXlJx_lv0FeEd4f", "language": "500", "code": "// Internal server error.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "MXMcN3yYVXpA3H3bARJlK" } }, "children": [ { "text": "" } ] }