Delete Data
3 min
// // overview leveraging the unique interactionidentifier provided upon declaring the declare an audio interaction , declare a chat interaction , or declare a transcript , this enpoint enables you to instantly delete all results associated with the interaction from our database note all source data is permanently deleted once a deletion request is received and processed this ensures your data is handled securely and in compliance with privacy best practices please refer to the elevateai data retention & security guidelines for additional details when the delete delete request successfully executes , an http status is returned to indicate the request was successful and all data associated with the interactionidentifier has been removed from our database if an error occurs when requesting to declare the interaction, a standard http response code is retuned to indicate the request was unsuccessful, along with a json response containing additional details to assist with troubleshooting // // request parameters & code example { "tab" "examples", "url" "https //api elevateai com/v1/interactions/{interactionidentifier}", "name" "delete all data", "method" "delete", "request" { "pathparameters" \[ { "kind" "required", "name" "interactionidentifier", "type" "string", "description" "interactionidentifier returned upon successfully declaring the interaction" } ], "queryparameters" \[], "headerparameters" \[ { "kind" "required", "name" "x api token", "type" "string", "description" "valid api key associated with your account for authentication and usage tracking" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "z4ojaichyk2u3vesn0hc ", "code" "", "language" "200", "customlabel" "" }, { "id" "cijoi5jjvvjwm3m ebgib", "code" "{\r\n \\"errormessage\\" \\"string\\"\r\n}", "language" "400", "customlabel" "" }, { "id" "6qttbzwcfezjoynvekz7j", "code" "{\r\n \\"errormessage\\" \\"string\\"\r\n}", "language" "401", "customlabel" "" }, { "id" "ked3nzp5ycf niv5wbk6l", "code" "{\r\n \\"errormessage\\" \\"string\\"\r\n}", "language" "404", "customlabel" "" } ], "selectedlanguageid" "z4ojaichyk2u3vesn0hc " }, "examples" { "languages" \[ { "id" "2dip3dmgafbpnowoclu4r", "code" "curl location g request delete 'https //api elevateai com/v1/interactions/{interactionidentifier}' \\\\\n header 'x api token {your api token}'", "language" "curl", "customlabel" "" }, { "id" "xtzzfozqf6d0lwse gi85", "code" "var request = require('request');\nvar options = {\n 'method' 'delete',\n 'url' 'https //api elevateai com/v1/interactions/{interactionidentifier}',\n 'headers' {\n 'x api token' '{your api token}'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "language" "nodejs", "customlabel" "" }, { "id" "gaooi2ehyhukwdaocmed9", "code" "var myheaders = new headers();\nmyheaders append(\\"x api token\\", \\"{your api token}\\");\n\nvar requestoptions = {\n method 'delete',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api elevateai com/v1/interactions/{interactionidentifier}\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "language" "javascript", "customlabel" "" }, { "id" "mxn1xxd2w6r7ikorutpnd", "code" "import http client\n\nconn = http client httpsconnection(\\"api elevateai com\\")\npayload = ''\nheaders = {\n 'x api token' '{your api token}'\n}\nconn request(\\"delete\\", \\"/v1/interactions/{interactionidentifier}\\", payload, headers)\nres = conn getresponse()\ndata = res read()\nprint(data decode(\\"utf 8\\"))", "language" "python", "customlabel" "" }, { "id" "ir7pqyvcmxlrkbxzn3fg5", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api elevateai com/v1/interactions/{interactionidentifier}\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http delete new(url)\nrequest\[\\"x api token\\"] = \\"{your api token}\\"\n\nresponse = https request(request)\nputs response read body\n", "language" "ruby", "customlabel" "" }, { "id" "fxu181kpopqiikhddvai6", "code" "var client = new restclient(\\"https //api elevateai com/v1/interactions/{interactionidentifier}\\");\r\nclient timeout = 1;\r\nvar request = new restrequest(method delete);\r\nrequest addheader(\\"x api token\\", \\"{your api token}\\");\r\nirestresponse response = client execute(request);\r\nconsole writeline(response content);", "language" "csharp", "customlabel" "" }, { "id" "bpxz2pg8s6xu1vsugemqf", "code" "\<?php\r\n\r\n$curl = curl init();\r\n\r\ncurl setopt array($curl, array(\r\n curlopt url => 'https //api elevateai com/v1/interactions/%7binteractionidentifier%7d',\r\n curlopt returntransfer => true,\r\n curlopt encoding => '',\r\n curlopt maxredirs => 10,\r\n curlopt timeout => 0,\r\n curlopt followlocation => true,\r\n curlopt http version => curl http version 1 1,\r\n curlopt customrequest => 'delete',\r\n curlopt httpheader => array(\r\n 'x api token {your api token}'\r\n ),\r\n));\r\n\r\n$response = curl exec($curl);\r\n\r\ncurl close($curl);\r\necho $response;", "language" "php", "customlabel" "" } ], "selectedlanguageid" "mxn1xxd2w6r7ikorutpnd" }, "description" "", "currentnewparameter" { "label" "path parameter", "value" "pathparameters" } } need more help? contact the elevateai support team