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": "Custom Consent Categories Updated Successfully", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "ConsentHistoryResponse[]", "schema": [ { "name": "tenant", "kind": "optional", "type": "string", "description": "" }, { "name": "siteIds", "kind": "optional", "type": "array", "description": "The site IDs linked to the configuration.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "history", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "versions", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "version", "kind": "optional", "type": "integer", "description": "", "example": 1 }, { "name": "categories", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/ConsentCategoryEntry", "customType": "ConsentCategoryEntry[]", "schema": [ { "name": "categoryId", "kind": "optional", "type": "string", "description": "", "example": "1" }, { "name": "dataPointIds", "kind": "optional", "type": "array", "description": "", "example": "[\"dp1\",\"dp2\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "enabled", "kind": "optional", "type": "boolean", "description": "", "example": true }, { "name": "createdAt", "kind": "optional", "type": "stringConsent Management is disabled or locked for the tenant, so consent operations are not allowed.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "Error response for validation errors", "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": "500", "description": "There was an 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": "viIR-Ykpj_8_-dKsRvKqn", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.upstartcommerce.com/v1/customer/consent/configurations/history \\\n --header 'accept: application/json' \\\n --header 'x-upstart-tenant: string'" }, { "id": "cpIWMdk-r5RV3bKdKBPvd", "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(\"https://api.upstartcommerce.com/v1/customer/consent/configurations/history\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "JTMsAxBF08wwYbpRILCgh", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.upstartcommerce.com/v1/customer/consent/configurations/history\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest[\"x-upstart-tenant\"] = \"string\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "flZ106Wxe2kVW8JG_UCFM", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.upstartcommerce.com/v1/customer/consent/configurations/history\"\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": "viIR-Ykpj_8_-dKsRvKqn" }, "results": { "languages": [ { "id": "oFAj4-NID8E7WCtpFseow", "language": "200", "code": "// Custom Consent Categories Updated Successfully\n[\n {\n \"tenant\": \"\",\n \"siteIds\": [\n \"\"\n ],\n \"history\": {\n \"versions\": [\n {\n \"version\": 1,\n \"categories\": [\n {\n \"categoryId\": \"1\",\n \"dataPointIds\": [\n \"\"\n ],\n \"enabled\": true,\n \"createdAt\": \"\",\n \"enabledAt\": \"\",\n \"disabledAt\": \"\"\n }\n ]\n }\n ]\n }\n }\n]" }, { "id": "IIzgV5RGWoDkBZ2s_N1vu", "language": "400", "code": "// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.\n[\n {\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n }\n]" }, { "id": "xqNrHIpliIewVqFfoFgU_", "language": "401", "code": "// The provided credentials were not valid for this endpoint.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "E_3WGiF2HMHQDHPaEmqYQ", "language": "403", "code": "// User's roles are insufficient for this endpoint.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "bkWeeNOfsokgemIWzbCuu", "language": "404", "code": "// The requested resource was not found in the NoChannel system.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "AIeMCz5VIGkIeyH-C-qGA", "language": "405", "code": "// This is to indicate that the server has received a request with an HTTP method that is not supported for the requested resource.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" }, { "id": "gQs1NsX1l7J3aL1Z066Zg", "language": "423", "code": "// Consent Management is disabled or locked for the tenant, so consent operations are not allowed.\n[\n {\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n }\n]" }, { "id": "AcX38XCSk_xyHWzLylPhN", "language": "500", "code": "// There was an internal server error.\n{\n \"name\": \"\",\n \"code\": \"\",\n \"detail\": \"\",\n \"reason\": \"\"\n}" } ], "selectedLanguageId": "oFAj4-NID8E7WCtpFseow" } }, "children": [ { "text": "" } ] }