https://learn.emailengine.app/assets/js/101c79c6.12ff8fc2.js

1"use strict";(globalThis.webpackChunkemailengine_temp=globalThis.webpackChunkemailengine_temp||[]).push([[3799],{26992(e,t,i){i.r(t),i.d(t,{assets:()=>x,contentTitle:()=>k,default:()=>y,frontMatter:()=>g,metadata:()=>s,toc:()=>f});const s=JSON.parse('{"id":"api/delete-v-1-tokens-token","title":"Remove a token","description":"Delete an access token","source":"@site/docs/api/delete-v-1-tokens-token.api.mdx","sourceDirName":"api","slug":"/api/delete-v-1-tokens-token","permalink":"/docs/api/delete-v-1-tokens-token","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"current","frontMatter":{"id":"delete-v-1-tokens-token","title":"Remove a token","description":"Delete an access token","sidebar_label":"Remove a token","hide_title":true,"hide_table_of_contents":true,"api":"eJzVWW1zG7kN/isYfkpm1rLkxLmL+uq7KK07Ti5jO9fpJJkYWkJanrnkhuTK1nn03zsgd6VdS6ndqzJtv9iSCAIg8OCF4J2wFTkMyppTKcZCkqZAP48u7TUZH/+KTEjyuVMVU4mxeBVpAA1gnpP3EBqyCh2WFMh5Mf5wJwyWJMbi9oDoIKiSbB1EJhSzKAglOZEJnxdUohjfibCsmFqZQPO41Bd6Tl9q8gEaRqAMlEpr5Sm3RvoBnKPy5CEUBLktSzRyTYtTu6C4Mpm8/cvp28nny9M3k5/eX4KkGdY6wMw6QNDWzA9cbYwyc3BJ4O8AYYG6JpiStjeRS7urQA/GAs1mlPPR6BbLSpMYPxsOh8NMlMqosi7FmD/jbfr83REvDlf/fwdcZWufth6PzqwwFLtc6YNTZr7lycuCesBJ0jOwLspOvykJM2dL1ln5kNiszStG03x0NMXZd7OhPKbj0YyG+JyGJHH4gkZTOp5+L1/k+VH+4sX05bHMh7MpPZdH9HJ2LI9phCITtwe5NT44VCawzprMPBRi/OL5ihdn1pUYFwq65X/TZaATreaGpBjPUHvKROVopm6br6vVlkt/80nZNcqxpOBqWn3KRMA5B5U4SexSeIpPTOorazx5VvJoOOR/94EVamc8IMTgVtZAie6a3AAu11r4YCsPN9ZdMzRUWZJUGEgvByITuTWBkpmwqrTKY744/MUz/7ttx9vpLykgKsfZJaikXcotskM4tVYTbmeYv6PvWKjdx1QRl41ZVpkIKkRApJQUrdLE0XljF7GKjnm+yzKnZoFaSVCmqgMcRJEMZtgksgy+1OSWgG5el2SCj95rQgcqXGqLEqSSYCx/9x4iz2ihAZxob8FFB5CEm4JMFEIlKg2e3IKY2az2JONCwzjj6L8pVF5Ajp6apXQgyNE5RezP3EpOw2nrmltDpowPhBLsDBBmirSMAPtP3Nm33s/rcwI5Z92Wv33AUPsfraRH5Pe/Xl6+g7Qjnqsb789jukxCHkwvXUaBbnt5WfyAEhqAiFUmSvIe5/Qw0wnLhpa8y7GHIeYZTe07LNE5XG5xPFM+sG8S9tImCAUGmKHSJDsw4jwbqPQPR9ijz/Nq842VYPxs5EUNatc/50dR4Zwu1K/0UUBZ+wBTAh1TW4GGg4K+1KghWBgNh0O2xDUtH9bkLZbUqtCxxddNsVGpVYhlxRr0oLDXtdYpwh8tcQAXrCF6uKZlU0aDrQ40LUinnRlIGwLJZtWQ5y/W9A0Y7GA4QCkdeS+6uWsTRxFlr5mleGDdM0Hej6yvnPkN5oUydOAIJU41pWCNMZaBmgEuUGle6Gn7BpWe2tu3Nry2tYn6SAqotH9Y4omUij+ibmQ1O/viUvW5lwmb3JUM2SbGMukC606VtVFmZv8LqqQA66rydU9tlaDRdgk6qUNBJjQ5uIVfKkW91kF5KJX3ysy5OER8xlJ0E1u0EImrVCX3lN/vqfbNc/xoTzn+vcE6FNapX0nuKcm/SZYH7Jmk5/u+tXb7/9kO/ycfSzJqt9+lpeTguUMToCIXYcBYiW2k8hswwpOmmcttRRnzsbUJESan76DJPQzt4FTOG57uES29g3xzsDzbE1heWzdVUpLZE1K64Et+YMZNW0fyIv7yqCtS3BzxsPGvIZIks00jeQ8j3BouQfWPiJVqdeA7xbs1gh6nRwdxCYKPUmmzy4O0UTllcl1Luq9eY0U/vnEqNNYqbaCTplQ+SslcKzKhg/IthdQG+NxrW7ChINeSk+/pdDR8NhgORqNng1E/yCPIX0WM7wzxo5c77l8YCLQqVQC6zaO5ONCthRLNsm35PdyQIyhREtyoUKTQvjdg2VOsdjX6xoF69HJPgXppLbxhezXtu99TwO7wTmy+gn7E0S/SbAZqE5ROt7QNuxtlpL1h1FHw/elQF1OswBlv2AWo493X1kCOW5qmV0mdzQEP5GpDtxVFiKdfbZ7XzsW7p9IElbMMKK5lnevm/pC1U7VvB6/jvV0M14pfJMWjM/YEsRMDaqfLWud862a+Pdz6UHtu5Xs5siesB+c4WCM6UGWFeYjDZh9cnQe1INGsYd5I3rE2d7auOsNHug1kYomJ4+Z43exJyEQcuN3jxmPMDm0j8VG0SYMNadKE53MlhcJuBuiivZGKw8XoMJL5w7v4f8Wj0oiCpHbtNA/EQ6j8+PAwXkLIzJWhQePAQW7LLcf8w9YOJkw8icQtsJ44qjTmTQ1ZMhXmod4g7/352dOosae8diosoxJTQkeOe1gx/vCpu3zBkZ/Ctku0Bg4r3g5/40gvEoms+fC6maMKW+GXmrajhtHS6tmpdavuFa9BVve4J+9O2Q/kUiMjjgbfHw2GTSKL6FrPqrvbLuqqso6R0Te7JnRm0DU+VtWhtLk/9OstcZljJf3y53vkHFha5cRw3y39rFm9L73LSNLi8Oz0x8nbi8nnyZuT07M00B+E2yC2Bsxd5pWzCyXjXPB8cnE5qzUbKd4SSjQ455yfrrjNvcBn4MlI/r3twbI4TewUibRBYkDA3Fnvoax1UJVey3N+8NF8NJMFT0nbuSg3hf7+A1EWx6NcmVRqvSLF1UnTL8eCM4YfImzg93HLH68gvRTxFYaJ/5QYfo6rf7i6N5wdNHNxQEegvK9JxgM5WtjrOJKJVa83Q4cq3ufTOKhrT5SlahL3DHOKp2x7D8A58nw1DV55PtSzbJTfWJGvAbzLBIVaL7nzvCaqQAUfixE/5hivPFffDLwFr9jEaMhywUOtffShNbRm/6WmmqCuYEqFMhII8yL1swM46z7xrNt05mR4YjdXCzJQWkfgrC3bVpPgqvtM15o923qF2vi6GRI2022/McXfLn56C2QWpG1FYx6I1SU5lcPVpu5fZYDgC+sCXMXCcgUap6SjuxCKukSzKXJXDT6vBjDho5KRlVXpKuJoxoeRNk/zebBGL5vZeadr8KBCtEFSN8q54YFfKGgJJaGJR4sDwpZXg8h/nSPi8NH6UKLpRP05lfwih+vOvRe3d5t26+uPqU1+5U7lsNKo4g015o27prZ8EIsRE6a3oEyM09ZPmSisD7x+dzdFT++dXq345xgtnOC5gjkVSzdnf6k8f948bH1V2yfnzS3yKfzmx62dB2tn5WbZKa+imSGv6+wqa1+O/z21//ffVr9ilk7vsXlBX5tn052cxOlfZ22rie81Ka8mZ5PLiVit/gmbkkA/","sidebar_class_name":"delete api-method","info_path":"docs/api/emailengine-api","custom_edit_url":null,"hide_send_button":true},"sidebar":"apiSidebar","previous":{"title":"Get token info","permalink":"/docs/api/get-v-1-tokens-token"},"next":{"title":"Get token audit log","permalink":"/docs/api/get-v-1-tokens-token-log"}}');var n=i(74848),o=i(28453),r=i(57742),a=i.n(r),d=i(78178),p=i.n(d),l=i(19624),c=i.n(l),m=i(96226),u=i.n(m),h=(i(77675),i(19365),i(51107));const g={id:"delete-v-1-tokens-token",title:"Remove a token",description:"Delete an access token",sidebar_label:"Remove a token",hide_title:!0,hide_table_of_contents:!0,api:"eJzVWW1zG7kN/isYfkpm1rLkxLmL+uq7KK07Ti5jO9fpJJkYWkJanrnkhuTK1nn03zsgd6VdS6ndqzJtv9iSCAIg8OCF4J2wFTkMyppTKcZCkqZAP48u7TUZH/+KTEjyuV

1MVU4mxeBVpAA1gnpP3EBqyCh2WFMh5Mf5wJwyWJMbi9oDoIKiSbB1EJhSzKAglOZEJnxdUohjfibCsmFqZQPO41Bd6Tl9q8gEaRqAMlEpr5Sm3RvoBnKPy5CEUBLktSzRyTYtTu6C4Mpm8/cvp28nny9M3k5/eX4KkGdY6wMw6QNDWzA9cbYwyc3BJ4O8AYYG6JpiStjeRS7urQA/GAs1mlPPR6BbLSpMYPxsOh8NMlMqosi7FmD/jbfr83REvDlf/fwdcZWufth6PzqwwFLtc6YNTZr7lycuCesBJ0jOwLspOvykJM2dL1ln5kNiszStG03x0NMXZd7OhPKbj0YyG+JyGJHH4gkZTOp5+L1/k+VH+4sX05bHMh7MpPZdH9HJ2LI9phCITtwe5NT44VCawzprMPBRi/OL5ihdn1pUYFwq65X/TZaATreaGpBjPUHvKROVopm6br6vVlkt/80nZNcqxpOBqWn3KRMA5B5U4SexSeIpPTOorazx5VvJoOOR/94EVamc8IMTgVtZAie6a3AAu11r4YCsPN9ZdMzRUWZJUGEgvByITuTWBkpmwqrTKY744/MUz/7ttx9vpLykgKsfZJaikXcotskM4tVYTbmeYv6PvWKjdx1QRl41ZVpkIKkRApJQUrdLE0XljF7GKjnm+yzKnZoFaSVCmqgMcRJEMZtgksgy+1OSWgG5el2SCj95rQgcqXGqLEqSSYCx/9x4iz2ihAZxob8FFB5CEm4JMFEIlKg2e3IKY2az2JONCwzjj6L8pVF5Ajp6apXQgyNE5RezP3EpOw2nrmltDpowPhBLsDBBmirSMAPtP3Nm33s/rcwI5Z92Wv33AUPsfraRH5Pe/Xl6+g7Qjnqsb789jukxCHkwvXUaBbnt5WfyAEhqAiFUmSvIe5/Qw0wnLhpa8y7GHIeYZTe07LNE5XG5xPFM+sG8S9tImCAUGmKHSJDsw4jwbqPQPR9ijz/Nq842VYPxs5EUNatc/50dR4Zwu1K/0UUBZ+wBTAh1TW4GGg4K+1KghWBgNh0O2xDUtH9bkLZbUqtCxxddNsVGpVYhlxRr0oLDXtdYpwh8tcQAXrCF6uKZlU0aDrQ40LUinnRlIGwLJZtWQ5y/W9A0Y7GA4QCkdeS+6uWsTRxFlr5mleGDdM0Hej6yvnPkN5oUydOAIJU41pWCNMZaBmgEuUGle6Gn7BpWe2tu3Nry2tYn6SAqotH9Y4omUij+ibmQ1O/viUvW5lwmb3JUM2SbGMukC606VtVFmZv8LqqQA66rydU9tlaDRdgk6qUNBJjQ5uIVfKkW91kF5KJX3ysy5OER8xlJ0E1u0EImrVCX3lN/vqfbNc/xoTzn+vcE6FNapX0nuKcm/SZYH7Jmk5/u+tXb7/9kO/ycfSzJqt9+lpeTguUMToCIXYcBYiW2k8hswwpOmmcttRRnzsbUJESan76DJPQzt4FTOG57uES29g3xzsDzbE1heWzdVUpLZE1K64Et+YMZNW0fyIv7yqCtS3BzxsPGvIZIks00jeQ8j3BouQfWPiJVqdeA7xbs1gh6nRwdxCYKPUmmzy4O0UTllcl1Luq9eY0U/vnEqNNYqbaCTplQ+SslcKzKhg/IthdQG+NxrW7ChINeSk+/pdDR8NhgORqNng1E/yCPIX0WM7wzxo5c77l8YCLQqVQC6zaO5ONCthRLNsm35PdyQIyhREtyoUKTQvjdg2VOsdjX6xoF69HJPgXppLbxhezXtu99TwO7wTmy+gn7E0S/SbAZqE5ROt7QNuxtlpL1h1FHw/elQF1OswBlv2AWo493X1kCOW5qmV0mdzQEP5GpDtxVFiKdfbZ7XzsW7p9IElbMMKK5lnevm/pC1U7VvB6/jvV0M14pfJMWjM/YEsRMDaqfLWud862a+Pdz6UHtu5Xs5siesB+c4WCM6UGWFeYjDZh9cnQe1INGsYd5I3rE2d7auOsNHug1kYomJ4+Z43exJyEQcuN3jxmPMDm0j8VG0SYMNadKE53MlhcJuBuiivZGKw8XoMJL5w7v4f8Wj0oiCpHbtNA/EQ6j8+PAwXkLIzJWhQePAQW7LLcf8w9YOJkw8icQtsJ44qjTmTQ1ZMhXmod4g7/352dOosae8diosoxJTQkeOe1gx/vCpu3zBkZ/Ctku0Bg4r3g5/40gvEoms+fC6maMKW+GXmrajhtHS6tmpdavuFa9BVve4J+9O2Q/kUiMjjgbfHw2GTSKL6FrPqrvbLuqqso6R0Te7JnRm0DU+VtWhtLk/9OstcZljJf3y53vkHFha5cRw3y39rFm9L73LSNLi8Oz0x8nbi8nnyZuT07M00B+E2yC2Bsxd5pWzCyXjXPB8cnE5qzUbKd4SSjQ455yfrrjNvcBn4MlI/r3twbI4TewUibRBYkDA3Fnvoax1UJVey3N+8NF8NJMFT0nbuSg3hf7+A1EWx6NcmVRqvSLF1UnTL8eCM4YfImzg93HLH68gvRTxFYaJ/5QYfo6rf7i6N5wdNHNxQEegvK9JxgM5WtjrOJKJVa83Q4cq3ufTOKhrT5SlahL3DHOKp2x7D8A58nw1DV55PtSzbJTfWJGvAbzLBIVaL7nzvCaqQAUfixE/5hivPFffDLwFr9jEaMhywUOtffShNbRm/6WmmqCuYEqFMhII8yL1swM46z7xrNt05mR4YjdXCzJQWkfgrC3bVpPgqvtM15o923qF2vi6GRI2022/McXfLn56C2QWpG1FYx6I1SU5lcPVpu5fZYDgC+sCXMXCcgUap6SjuxCKukSzKXJXDT6vBjDho5KRlVXpKuJoxoeRNk/zebBGL5vZeadr8KBCtEFSN8q54YFfKGgJJaGJR4sDwpZXg8h/nSPi8NH6UKLpRP05lfwih+vOvRe3d5t26+uPqU1+5U7lsNKo4g015o27prZ8EIsRE6a3oEyM09ZPmSisD7x+dzdFT++dXq345xgtnOC5gjkVSzdnf6k8f948bH1V2yfnzS3yKfzmx62dB2tn5WbZKa+imSGv6+wqa1+O/z21//ffVr9ilk7vsXlBX5tn052cxOlfZ22rie81Ka8mZ5PLiVit/gmbkkA/",sidebar_class_name:"delete api-method",info_path:"docs/api/emailengine-api",custom_edit_url:null,hide_send_button:!0},k=void 0,x={},f=[];function v(e){const t={p:"p",...(0,o.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(h.default,{as:"h1",className:"openapi__heading",children:"Remove a token"}),"\n",(0,n.jsx)(a(),{method:"delete",path:"/v1/tokens/{token}",context:"endpoint"}),"\n",(0,n.jsx)(t.p,{children:"Delete an access token"}),"\n",(0,n.jsx)(h.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(p(),{parameters:[{name:"x-ee-timeout",in:"header",schema:{type:"integer",description:"Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect",example:3e4,minimum:0,maximum:72e5},description:"Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect"}

1,{name:"token",in:"path",schema:{type:"string",description:"The access token value, or the token id from a listing",example:"1bc12baf7f0d5e51fe0a4e0eda06e1be5b8d6cc2c66b95dc0fbe4d2e9f5d5e1a","x-constraint":{length:64},"x-format":{hex:{byteAligned:!1,prefix:!1}}},description:"The access token value, or the token id from a listing",required:!0}]}),"\n",(0,n.jsx)(c(),{title:"Body",body:void 0}),"\n",(0,n.jsx)(u(),{id:void 0,label:void 0,responses:{200:{description:"Returns a deletion marker. The token stops working immediately.",content:{"application/json":{schema:{type:"object",properties:{deleted:{type:"boolean",description:"Was the token deleted",default:!0}},title:"DeleteTokenRequestResponse"}}}},400:{description:"Invalid input - the path parameters, query arguments, or request payload did not pass validation. Also returned when the email server refused the request, in which case the response carries a code and the server response instead of a field list",content:{"application/json":{schema:{type:"object",description:"Validation error",properties:{statusCode:{type:"integer",description:"HTTP status code",example:400},error:{type:"string",description:"HTTP status text",example:"Bad Request"},message:{type:"string",description:"Error message",example:"Invalid input"},fields:{type:"array",description:"List of input fields that failed validation",items:{type:"object",properties:{message:{type:"string",description:"Description of the validation failure",example:'"pageSize" must be less than or equal to 1000'},key:{type:"string",description:"Name of the input field that failed validation",example:"pageSize"},path:{type:"string",description:"Full path of the input field that failed validation. Same as key for a top-level field, dotted for a nested one",example:"to.0.address"}},title:"ValidationErrorField"},title:"ValidationErrorFields"},code:{type:"string",description:"Machine-readable error code, if available",example:"MailboxNotFound"},details:{type:"string",description:"Additional error details, if available. The email server response for a refused mailbox operation"},info:{type:"string",description:"Additional error details, if available. The email server response for a refused message operation"}},title:"ValidationErrorResponse"}}}},401:{description:"Authentication failed - the access token is missing, invalid, or was not accepted",content:{"application/json":{schema:{type:"object",description:"Authentication error",properties:{statusCode:{type:"integer",description:"HTTP status code",example:401},error:{type:"string",description:"HTTP status text",example:"Unauthorized"},message:{type:"string",description:"Error message",example:"Missing authentication"}},title:"AuthenticationErrorResponse"}}}},403:{description:"Access denied - the access token does not grant permission for this operation (token scope, account, or IP address restriction)",content:{"application/json":{schema:{type:"object",description:"Access denied error",properties:{statusCode:{type:"integer",description:"HTTP status code",example:403},error:{type:"string",description:"HTTP status text",example:"Forbidden"},message:{type:"string",description:"Error message",example:"Unauthorized scope"},requestedScope:{type:"string",description:"The scope the operation needed, when the token does not carry it",example:"api"},requiredPermission:{type:"string",description:"The permission grant the operation needed, when the token permissions do not include it",example:"messages:write"},remoteAddress:{type:"string",description:"The client IP address, when the token is restricted to other addresses",example:"203.0.113.1"}},title:"AccessDeniedErrorResponse"}}}},429:{description:"Rate limit exceeded - too many requests were made with this access token",content:{"application/json":{schema:{type:"object",description:"Rate limit error",properties:{statusCode:{type:"integer",description:"HTTP status code",example:429},error:{type:"string",description:"HTTP status text",example:"Too Many Requests"},message:{type:"string",description:"Error message",example:"Rate limit exceeded"},ttl:{type:"integer",description:"Seconds until the rate limit window resets",example:30}},title:"RateLimitErrorResponse"}}}},500:{description:"Internal server error - an unexpected error occurred while processing the request",content:{"application/json":{schema:{type:"object",description:"Internal server error",properties:{statusCode:{type:"integer",description:"HTTP status code",example:500},error:{type:"string",description:"HTTP status text",example:"Internal Server Error"},message:{type:"string",description:"Error message",example:"An internal server error occurred"},code:{type:"string",description:"Machine-readable error code, if available",example:"InternalError"},details:{type:"string",description:"Additional error details, if available"}},title:"InternalErrorResponse"}}}}}})]})}function y(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(v,{...e})}):v(e)}}}]);