---
id: delete-identity-profiles
sidebar_label: Delete Identity Profiles
hide_title: true
hide_table_of_contents: true
api: eJztW21TGzkS/isq34dNUozxGxj7y5V5yRZbZOHAVD4AdZFnZFvJWPJJGohD8d+vu6UZz9gEWJK6293yblUKa6RWvz7drdHc1/RcGO6kVsdJrV9LRCqcOE6EctItzowey1TY2lbN8Ymt9a9q+SNWPLvZglU2NnKOVIDGcCot84Qsm2Wpk/NUsLWF7FZyxlkqrWN6zGw2n6dSJOz40Nav1bU6VTAWx8LaLeaQpFDJXEvl2J1MU2aEy4wCAkaMhREqFsxpmCjYKEu/hP2Z4/YLzLDABREdwKQvQgEJN2Wn57/+e3D44fh3xjM31Qa5g32M+E8mDXAC9GIOW9Hug7NjojCEHcY6TfWdVBNm5GTqLONGVJZx4rvKdp/JRPVlUEM092roe0ZBw7heWLevk0Wtf7+i01XtVYQMK9kIltYDJeSk1ncmE1u1WCsHy5EqRyXHZO/tzxZJ39dsPBUzvr7nSbDM2t5gIRTS744busVcwAJuDF/AT+nEzCK9MG6dAV3VHrZq4iufgTOgI7XiXnOvsbfbHbV4uyMajWZ31G5095Ldxqix2+sBnWem7KHrAWNIr7bisvugnkOv2Qf4D3Vi51pZQXy1Gq11cQdgs7kD+0XsnHwLzMqG4D/n5D5Mjz6L2BXuhtZf9bbPesRiIzhQQbW8Uu8Dle9FXlphYunsYJhHtl8aw5OA3+BoEOJOetFlsm6YtQDGoPGOOpbC1Ep2q43HYJHmXrOT9LrduNVswF+8sbO71+jwBh+30cqKz8QLd6GpZfr7PP4yMTpTCTv1ShgKM5OKO21YvDdutBvjVjRq8t2oI9rtqNcTe9Fur70zipt73fZOggxUNnoRH+WhMju/CiWMjD2OjIEFF7hB8yfccSYV2UHfCpPyxRbLLLjQaEGDOetA9UKYWxlDtAB7Kc8U2N48z9ulFYbBrmBDApS7qWZhdUI7IF8VhhFGtXG4TaxxzIlHLQ6yzLhDxAdvjZwkM1Q3P+QIoPAEfS0QW9XPB63YIJuwVpM1O/2dbr/dYweHQwYR1i6J+uMs3E2FKiRmd9wWeniKn51VfpZiXDjuskdQCqipbIYIdeGzD4x85Eb5Z0fGaAyI3LK0/VDM5v7Bei5c5h9m/Y5ldvMtEKFyJFtG+4WEaRiCSQCxTqOxDhcHkDUhKRIDBXaBe0gPEOXkgNlNqlueyj+GT09DSiIcl+mBTl4Q9O+lEtHEcIkcCmI5hoXo4LcywaCaacilnmSOcTSvXlEcaKLeZPs8AXm9fAdBGNSkARABWscvwLpLJWE9y5cA7Pkwf3xb0RV8tNvotTrj3Q7nrb1Os7sz6o15u93o7UDSgt1nYFA+EWXXyhNjdescW1INVYb8BgqB1AG6JwZEcLTVXPodGxCNl4AuyOXnFmIGfgHZvrotyDb7B2es04XwUpOMxvlkRQkquryAEZWlKR/hEJYZGOxE+BRqIvko7uaBdXj0fnB5MoSR86N/XR5dwF9Iay14IBFKlaBbAqvgC1N9RxwHARAELGS+GNMtexeovgOBuLLlidL/sgsLygTfGnMsB9m7sPsjK8qk2djoWSWUKG6+OvZG1kV9i41wDJAsnrIRR/TXHqne+YoiOgmafMemgifCvK2zQZJIFJKnDKIxwzqZL4AQ40mCoesJjDMIZUFVgM4cU9pRBinbYqnKqjWWcHJSNgoGB3D+vJ8MYpcBcyRmOQoLbwksBvsAz15zVe6GJaWRShfK8RikgKp6AWo0BhP8CGSTUEQHOEJzWQAelc8rEKuMkgR3Hzwzh07Ts5hn9gVxd5YC/EQkWvHgVoTgo8rWoxFZIzdTQKTQYtDiMKswVx74DBA7TTaxu4ndTey+MHZXH56Hbi08pdKnuV76XKrQuH8rtW1F6WPIe5TOu/tvVN4EQ25hWR1KpN8+DsOxALbrX+fYO//E+sin8vU2r7CHHx/lHWWe+pe2QAZJj16CMSCRSPrE95JjUpRXVXt9t/fajCQ4qHqkRMywy1jozB9jZAprXcbtFku0sOoXx6Yc8DE/09DFsUZE5xqbSnJTSW6y0SYb/X2y0aaS3MTuJnb/mrH7ZCVZcEXREuokm81m3Cy8p4XnKC1nMIHl7w1YEXJkqtVqBYmxosaqVSuH2qjVHDXH3Vh0Et5Jdtu9cSvebfGdbrPbHHVa3Vo5118t47gIsmpMlezt7UgqhiLuFuq4TIFzWad1Uj3+y+jlAcIavaDK62bQOaj0pqgdW7312nGoNfvA1SKvkGylhlRLHSGmwdwZzjX5XIkv6SaAi4oBVEngC10Jz3QjZvB8N5UzScGLUgBds4gGYwei+EDJnazYRao4zYBDQoJUY9WswbEkCCnGWPMBBapgJ4DOP7E6DSb6oUqenaPEJygxO/oaC4GBXlTuO4+d7x4D8wYx4sIb+DsHvb7b4QocABoCj1lF3bmpzzf1+SbHb3L83yPHb+rzTexuYvevGbt/oD4P1dD363OY8OL6HObWG6yopd6jc/3Py3QKlcABuTfTcZwZOm7Oa3BQghUwKN2CNsErIAfelQdQtGNkPnWP7ObhBrkEX0SJ5toSCnFcWNteXWS38fpQVFxB8y2EFy4zKSyZOje3/e3te7A52PqhzueynpNR+q4e69n2CBT9CIbhZQMfrzgBL9CFHqVOVjISA8GjJhH3NiO9oMuD7eh8+UnKeH8InWGhM7ybg2S2GARNcEoaxjsf0JH8Yml2nZxwTT6Q69KkDz8uiyf0HVkeU9+Tu8F8BpyuiIgi3Cz95ALLd7/7mrcsUxK2fK21zU5xWovtC26gt/BvQd789nH4lk2waCXQyCzWy0JilwFhdwYuQqA4yN8I4CLKU0ZnkykxPqi8c8EgZOMUBGbX6kIIdpXf1/sdssU5wDupFBcJQhRcdfMmt04ibkWKibS+1CQ6HgTCNmhom1fWvaWkSd2FVP6SEYzWr1XEDiVimcTkj3OCiNQssqt5LhcvyfVaJv6RU4s8tYio2bcrXHjVXsX+Dk8MSIAkeGpJW6/e3NOLSvSwFYMRpLrKA2oi8FF9UxbnVns1HxV6EdKr8nGtPk4lZOTqMubxi1lIqGnCjlk81dqKfzKGroNhcDXJIIpezdYdbhpRREStRomlyG8ZyQjqS+LvBAJDeWfiI8zvVN5oqPxU4kPyE1kWYv4TdN8J+1SRmYavIA3jzETH9tU844YRbhh5DLCBf5/l0LHwSh3IQDjgHeBgaX9CgsBoCfc8rUdRnchv0xpMDTGwSlTsvO9/9JcAF/5i9ABnF3MAhrE8L94d4n3qQAtTXUVZ+cHCqgbX+U01ZNgVvXl+i4MtzLp/NnlR4sHy/OVUpYufjdLfQZI/D+7+nxBvgzR/R6QJBTOeY54vP584+ulfGaA/k1wrXxtgFO2HgnD9wBFPxKcC/oWnBAZU/PP8Yj+WSWVC85Q7DBv/AclUCjqqmAvusLjcQtfVMwr1cB0cGlIiNKFPDgzohENzKVOgR4fp+c6cItJXrug4+Ntm/nY9fuMyhdZX1NlH6B5VDHbHzhGvg8Czzzq0kBdg+jP6+uYw9yao6mazTOGXIcB2NmMcfPYZl0ukjTOPjNBIquIjB021ZbEqhwn0ZRSBPjIRZmZPx+EifcmzntkLHMuGI3BQPVrRf59QWwpyLlJyfZxX7Queow3uHE1FOqe77sAWdKKlHT4cD9coAjFlQa5Y1LWZbIdFdhvnAhHsv7z7tOvNeiOifgTGsZODbrvCPn30sf5B1tr3D8Xp/+bTrNd9mhWSM3ZV23M8U0SLZL7L8701NuUrvTWsK3fXgCJT7MZh6v09nkBhu/mAw4BbeLxxdbPsJPEXbOFPoqgd/yLwBCS8+oiGCyo7wlHH+jsdbHD9Cn+69eTc8oHB2Sme89VG4SO0mT88MfwOBvHffu0a/ocfeu4DBibR+H0tP4qEOZ5uXt89Vt6EP1DMh4f/AhlQwgo=
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 Identity Profiles' (delete-identity-profiles)"
---

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 Identity Profiles</h1>

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



This deletes multiple Identity Profiles via a list of supplied IDs.

On success, this endpoint will return a reference to the bulk delete task result.

A token with ORG_ADMIN authority is required to call this API.

The following rights are required to access this endpoint: idn:identity-profile:delete

## 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><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>

Identity Profile bulk delete request body.

</div></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

string

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"202"} value={"202"}><div>

Accepted - Returns a TaskResult object referencing the bulk delete job created.

</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task identifier","example":"ff8081814d977c21014da056804a0af3"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task name","example":"Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Task description","example":"Generic task for terminating data in the overlay, used by the TerminationService."}}></SchemaItem><SchemaItem collapsible={false} name={"launcher"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"User or process who launched the task","example":"support"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Date time of completion","example":"Mon Aug 21 14:57:39 CDT 2023"}}></SchemaItem><SchemaItem collapsible={false} name={"launched"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Date time when the task was launched","example":"Mon Aug 21 14:55:39 CDT 2023"}}></SchemaItem><SchemaItem collapsible={false} name={"completionStatus"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`Success`, `Warning`, `Error`, `Terminated`, `TempError`]"} schema={{"type":"string","enum":["Success","Warning","Error","Terminated","TempError"],"description":"Task result status","example":"Success"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"ff8081814d977c21014da056804a0af3\",\n  \"name\": \"Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d\",\n  \"description\": \"Generic task for terminating data in the overlay, used by the TerminationService.\",\n  \"launcher\": \"support\",\n  \"completed\": \"Mon Aug 21 14:57:39 CDT 2023\",\n  \"launched\": \"Mon Aug 21 14:55:39 CDT 2023\",\n  \"completionStatus\": \"Success\"\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></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>