--- title: Update Configuration Template slug: api-documentation/rz1z-update-configuration-template docTags: createdAt: 2026-08-27T16:58:05.037Z --- { "id": "UxLkan-p7elpSHAYMxwMl", "type": "api-oas-v2", "data": { "method": "PUT", "url": "https://api.upstartcommerce.com/v1/order/cfg/templates/{templateId}", "servers": [ { "url": "https://api.upstartcommerce.com/v1/order/cfg/templates/{templateId}" } ], "name": "Update Configuration Template", "description": "

This endpoint update cfg template.

\n

Authorized permissions:

\n", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "templateId", "type": "string", "description": "Unique identifier for a given template." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "text/plain" ], "default": "text/plain" }, { "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": "UpdateCfgTemplate", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "" }, { "name": "propertiesDec", "kind": "required", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "enabled", "kind": "required", "type": "boolean", "description": "This indicates whether the template is currently active." }, { "name": "accessControl", "kind": "optional", "type": "object", "description": "This defines the structure of the data for an cfg access control.", "modelRef": "#/components/schemas/CfgAccessControl", "customType": "CfgAccessControl", "schema": [ { "name": "read", "kind": "required", "type": "boolean", "description": "" }, { "name": "modify", "kind": "required", "type": "boolean", "description": "" } ] } ], "modelRef": "#/components/schemas/UpdateCfgTemplate", "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": "ApiKeyAccess", "name": "X-Upstart-Api-Key", "kind": "optional", "type": "apiKey", "description": "Api key based authorization.", "in": "header" }, { "id": "SessionIdAccess", "name": "X-Upstart-Session-Id", "kind": "optional", "type": "apiKey", "description": "

Session based authorization. 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.

", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

Success-template updated successfully.

", "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": "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 } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "rEZuEOzJk5Bz60URvwpZG", "language": "curl", "label": "cURL", "code": "curl --request PUT \\\n --url https://api.upstartcommerce.com/v1/order/cfg/templates/{templateId} \\\n --header 'accept: text/plain' \\\n --header 'content-type: application/json' \\\n --header 'x-upstart-tenant: string' \\\n --data '{\n \"name\": \"\",\n \"propertiesDec\": \"\",\n \"enabled\": \"\",\n \"accessControl\": {\n \"read\": \"\",\n \"modify\": \"\"\n }\n }'" }, { "id": "EksTORO4FO5Td2Np5HrKY", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"text/plain\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-upstart-tenant\", \"string\");\n\nvar raw = JSON.stringify({\n \"name\": \"\",\n \"propertiesDec\": \"\",\n \"enabled\": \"\",\n \"accessControl\": {\n \"read\": \"\",\n \"modify\": \"\"\n }\n});\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.upstartcommerce.com/v1/order/cfg/templates/{templateId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "dO2JrjYYvFVj_cNSYVlWI", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/order/cfg/templates/{templateId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Put.new(url)\nrequest[\"accept\"] = \"text/plain\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\nrequest.body = JSON.dump({\n \"name\": \"\",\n \"propertiesDec\": \"\",\n \"enabled\": \"\",\n \"accessControl\": {\n \"read\": \"\",\n \"modify\": \"\"\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "5XKz-9g1NUHs0FkpKhPGd", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/order/cfg/templates/{templateId}\"\n\npayload = json.dumps({\n \"name\": \"\",\n \"propertiesDec\": \"\",\n \"enabled\": \"\",\n \"accessControl\": {\n \"read\": \"\",\n \"modify\": \"\"\n }\n})\nheaders = {\n 'accept': 'text/plain',\n 'content-type': 'application/json',\n 'x-upstart-tenant': 'string'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "rEZuEOzJk5Bz60URvwpZG" }, "results": { "languages": [ { "id": "lSIL0-Whb3EIY9ZnuewcO", "language": "200", "code": "// Success-template updated successfully.\n" }, { "id": "2Pebh603nUuxb0HFrBugA", "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}" }, { "id": "sZYntzLGmD5gAWnevNWnZ", "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}" } ], "selectedLanguageId": "lSIL0-Whb3EIY9ZnuewcO" } }, "children": [ { "text": "" } ] }