---
id: bulk-delete-roles
sidebar_label: Delete Role(s)
hide_title: true
hide_table_of_contents: true
api: eJztW1tv27gS/iuEzsO2RezYjuNLXg6cJl1kT7rpyQV9SIJdSqJtNhKpJaWm3iD//cwMKVmykya9YM9uYRRILYmc+wy/oai7QGfC8FxqdRQHe0FYJDcHIhG5ONWJsMFWkPOZDfYuA3d9vRXEwkZGZjgFJpzPpWWTd0dMKplLngvLOEMqLEYyMIjpKdNKMG1Yqo1gRKh9pa7UhOX6Rih2K/M50thiJ6c//zY5eHv06xY7PTk+LH/DVLo8u9inO4wX+VwbmS8YcDfij0IaEQM1FvEkYbmXqc2OFONxLFGMLZCrxu4xeilfgLTJokmJySnDa5IdVI2SIgaGUsEIQQIImzMO2nFrdYR2IHHOdGEimEEsU674TKRC5exWm5uZ0UVm0Tq3cxnNiVJTKom2TEUaCtMGT3g2+zpeBHt3Qal2sJebQmwFkVY50MZHPMsSGZFXtz9Y9NNdYKO5SDn+yheZAM/p8IOIcqCbGYyBXIJ7kSyoeBTTz6anjyWoCNIeHZDQzhSgYyicq0WMQnri3Bi+gEuZi9TWmNrcSDUL7rcC8YmnWSIwtHrRuDvqjPrDUbcnOmG304Vfw85ud9wdiyjiQMcPGfkhPRoiur3xtLvbHXUHwfX9/VbNJJeVHhCxucyREYXw/jLAnTkbstTUv1zyHPR3RiHxHAxG4fghsWgIH9GQFbGcYDbTyjoL9zq9deueirwwChwO+UKOcTGDQSFjtDf+yrm9YeCrqTYpmJHuOduzKo3RCV8dCiu5jexA9CLJ22tx4qauOvYzJNjB+QnD0UhLqCJFG59Pzv7z2+nh2cXxOXqqckTjARhQxl/G6+iAuFTk+oM+F8NwOhx3RX88jcNhf9AZ8J7o89F4sLOLPBRPv1CjWNosgYKBM5GfKpKEh8jQpWTFHx9gHJSRiEROicZBrlci0LOvG8Dp/7QSpQ6OHTLsdzrrsfY6kViEDo2BwtpiLvSwnE0b5SyEQoM1SKqPPJHxNwVWM3ZikXOZvNbxM+z9RirRmhkuUUJBIkcwkQHFjzLGLKBVxZEsE4XGrURAp9Pusn0eM5/47LVXBv1ieHQDtI6eEWYXSsJ8Vk7B9IR8fIytGAoeDjrjXn8K3uO9Ub873A3HU76z0xnvjsfIPRXWwspQr5Nl/Wyy/lkoYWTEEg2rk/wTDGIEB9uTAMT8gZL7iA+IxnPiHfRyYys1vbwsF59yXFb3X79j/SFLuJoVdJ/PVoygWhdna/kBmjvCJ0bOpHpIlLJMHBy+mbhEOD3878XhGfxCWmtoZKIgWmMMSxAVYmGub0lir8Att8xCvYxwsWKvPNVXoBCH0lsbKN2VXVgwJsTWlGMNZK889wdm1EmzqdFpI5Uobz7l7IVsi/YWLJlwL+U5rPohtzBBOyDxahJFIstbx96Sr9hc8FiYl2028TCGJwyyEYgSUoG1F/DNEolMC0hlQUuHLnKmdC4j0fTF0pSr1aosTsd1p2BygORPx8kkygsQjtSsZ2EVLV5E7x+Q2VmuKd15zWhk0oXKeQRaAPoCTKaNwaUxBN1kbpkvR+guC4VHleOqilWvuVTu3jphqOrCs4gX9hl59y6B8tMi1aoHH4VPPgJBrhqJCm2CJXxFgoe0dONkP6pyV5n4bCpFEm9yd5O7m9x9Zu6uPjz1CLuJpyhbHl/5H0DhjgqlS8jjZhAozETy4CqI+QyPJrgIuoJ3eRyFo37M+/j/uNPt74rO7rC/Oxz2RVCHA5fLVK/ysJl2tZBwrv7uXrj2MBLUw/4J4I5liUxlzj5KnXBnuDU7PjKSlY3QtxtyOOSAenk0mHZEv9eLw2h3NBoNBjyMer1QjL/ZkL4TBBMVYCDxKRICszXln7xWkCm7HRcp0FS2XCPWsFi73+mDHlNhhIqwVLjODlIbphUqfigAHx38TNs9yfOvtmNNltKkl1dPNtdXwTWFbyW3M2zZ1XTXTXeh/C4O4uK1rsbQwqB0udXzp4tHV6Nph8l3P7+8P/f7RDBefMpwP+E7tj4Opa8JP6lKrbsflu19ieqXZRYFpOR0GkzB/yLeI7mXEgdLU+2sc3ujTShh7VEPdH8AiAxb6IJ2s0yhFErC7RaLtbDqp5zNOUAfDoudtQ7cIFcVtzItVb5pEjdN4gZoboDmjwM0N03iJnc3ufvPzN0vahIJJ9kiTblZuEjzz1FbzmBAhcBZlXKPAfEdVmGsVcAd9rphdzqMBHWAg53xtBcNenx32B12w35v+F06QABxHwHHAW4WxuZax82dfTCvEVMsa1h6KtwMNm/A7N54HTuea83ecrUoEZJtYMhlh0c1DcamONaUY2EAZzOoiwrfY0ntXm3JVAAVA0HjWitMXtQC6JpFazLNQRWXKMtXrp6LfxdrqRIkGlGzhsCC9iwUU8R8QIEQ7Ayq83dEp95F34Tk2SlqfEzN5GHZX1bIffehVzdHILzBGnHmHPzIOxzX7XAFAQANgatZFe7c4PMNPt+s8Zs1/sdY4zf4fJO7m9z9Z+buF+Bzj4Yex+cw4Nn4HMa2O6zCUm8wuP5ymE6p4iWg8GY6igpD280lBgcjWAE3Zb4gJheA61+7UJ4AaMfMlLHaw331VqEAuEU3It5zBw3p1JB/tvLk+v4apYcYRU0zbak6cSQYbOMEu117pRGgEIg2naKFSWDYPM8zu7e9fQf+B7/ft3km21AWIQTyhdK37Uin2yEY/YF6hmeKXO7iADpf6Ri0yWNGYlK4CkrEnf/IRhj+4Efaa/4sZTwIhYGx0AXUTCKzhafPfIDSbRAxg+7kJ+sPcKG91/QDvS5Mcv/tujhCj+jykPk+yw3GM5B0RUVU4XoZM2cI5R33tchZLk/Y/vXWmJ3gsB7bF9xAn+HeiLz45f35SzZDAEsFpLCInYXEjgNS8B2ECBXISfl2ACfRmmV0MXOnGSeN9y+YkGyagMLsSp0JwS6PvBF+hZXjFEo9mRQnCaouOOv6RemdWHwUCS6q7aUlMfAg8LfBQtu8Me8lLaDUaUiFZyjdgckr1WIHEuuaRCCAY7yK1Diyy6zUi9f0+loh/lVSazlqLaJmX65I4Ux7GbmjehFUBSTBE0vW+mrmjl6rRg/bMriDVFdlQEt4OZpvzaLSa18tR4NeC+k15bhS7+lQdHMaczWLWVhck5gdsWiutRX/ZgxDB9PgclZAFn21WHQSu0UZ0ep1aiK1HMuWbAHWJPmOITGUCyYe4lpPUEcDClSxS8nfybOQ879DJx6z3xs60+1LWJJxZKwj+9UyI8MWMmy5GmC9/G7Fw8CC3EYdqA64AHi99D9VAi9ore45Wg9WdSK/TXNwaYhAVKJisz13sbcscP4Xowc4uhoDZRihevUeEY/Xe1q47DWMVW4yrFpwXd5Ew2q7Yjcnb7XJhSvw301f1Hiy3Is5Ucnie1fpRyrJ36fu/p8q3qbS/IiVxoNn3NM8XX42c/i57zy+8fMTQNsQ26Sjb2nqGbXvweH6RiTulM8F/IWnVBioKeD1D0DqhLKE55hCVEKiuRS0hZEJniPQ3MIw1imlfWY01pry66OZgTFQIywAYB7KBOjRJnvJmVN2OhSLQYTXtnCHh/DDqjm0xKLN3kNXqSKIAewo8ZgIPPugfWt5BmHwDqOIHZSRBQgvTQuFn1aB2EXKOMTvE+EXSxsVrkpCg6mqj2E04cxqVlkyMK5RBfr8SJjUnkxxdxwa71qUPcELgsz6rXEwPXrRfUkRLBU5Fe4MG45r9ghP0YbQbs1FkmFPCyVe4BmuJYe3R+drFIGYsvTtWFub2bafZLdxLBDBXsyFz0672+60qDeB+9jJQYvXEJ++DsLzeC/sy9Xou1u+C9h8yPfXfcjnl3TsxbYz3JVE3xWuN3RduPt8DSOt3odDZzfHXh0e393hvhU2pvd4G8TGTZHL62XPiVdA1u1fUeN+I3DfxL8waZ0vstpJwvU3QdgKuxluT+yzY+vbCe9OcHcwCP1niqnbcjH8Fm7i373gCv7Bhc5cOmE1xvt3QbmBCWMc3RIJPgSE/A9U8/7+f/loXrA=
sidebar_class_name: "post api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Delete Role(s)' (bulk-delete-roles)"
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Delete Role(s)</h1>

<MethodEndpoint method={"post"} path={"/roles/bulk-delete"}></MethodEndpoint>



This API initiates a bulk deletion of one or more Roles.

A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Roles included in the request are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"roleIds"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"List of IDs of Roles to be deleted.","type":"array","items":{"type":"string"},"example":["2c9180847812e0b1017817051919ecca","2c9180887812e0b201781e129f151816"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"202"} value={"202"}><div>

Returns an object with the id of the task performing the delete operation.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`TASK_RESULT`]"} schema={{"type":"string","description":"Task result DTO type.","enum":["TASK_RESULT"],"example":"TASK_RESULT"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task result ID.","example":"464ae7bf791e49fdb74606a2e4a89635"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task result display name.","nullable":true,"example":null}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"type\": \"TASK_RESULT\",\n  \"id\": \"464ae7bf791e49fdb74606a2e4a89635\",\n  \"name\": null\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n  \"type\": \"TASK_RESULT\",\n  \"id\": \"464ae7bf791e49fdb74606a2e4a89635\",\n  \"name\": null\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Client Error - Returned if the request body is invalid.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"400.1 Bad Request Content"} value={"400.1 Bad Request Content"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"1ea1adcb84da4dcb890145e05745774e\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"400.1 Role ids limit violation"} value={"400.1 Role ids limit violation"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"77aa89ac6f0e422dbc588866abc22be9\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"roleIds count exceeded max limit of 50 for bulk-delete.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"400.1.404 Referenced object not found"} value={"400.1.404 Referenced object not found"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1.404 Referenced object not found\",\n  \"trackingId\": \"77aa89ac6f0e422dbc588866abc22be9\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"Referenced roleIds [\\\"2c91808876438bb2017668b91919ecca\\\"] was not found.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"403 Forbidden\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The server understood the request but refuses to authorize it.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal Server Error - Returned if there is an unexpected error.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n  \"detailCode\": \"500.0 Internal Fault\",\n  \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"An internal fault occurred.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>