developer.sailpoint.com/docs/api/v3/create-branding-item.api.mdx

---
id: create-branding-item
sidebar_label: Create a branding item
hide_title: true
hide_table_of_contents: true
api: eJztW91TGzkS/1dUcw+bpDy2MSQcvOyZj2yxRQLHx+YBqIs8I9tKZqQ5SQN4Kf73625p7BnbBI5NsrspvyR4ptVf6v51tyzfRboQhjup1UEabUeJEdyJHcNVKtXowIk8akWOj2y0fRFVj6OrVpQKmxhZ4EJYdjaWlvWPD5hQaaGlcswzsoyzQVjFJHBrX6o+c/qzUOxGujGuabGjk1/+0997d/Ce8dKNtZFuwoCfEf8tpREp0LOEZxlzQUobdMKXwrodnU6i7buooo22nSlFK0q0ckI5fJWXmZMFN64z1CaPU+44PrbJWOT0l5sUAmzQg08icYG153URKZ4LeFQYnZaJe4+frugjeM1JYXE90cz4WGfQR/MuQiqmh013AJW45XmR4cKktE7ncUUQE8F9U/ijYgIxC4rPuM+9UGWW8QG+QYeBFJ4gh53SOa12dabN47LG4pZd86wkuxJcw8DFzHNiA2LV0KHb3dzY24qCtGtxKNXnPyYrAw5NEWtr+29IhOLXckSR/cdEzPiwATcPCINQktlbo/N+mhph7ePSaAUbwhLGw5o6a6VjI4ps8i8LZJRS7URTOGR6JNWBwmAmrXj2Dhbz0ROCg5YyOVvL8rC0LhqFDGUmTh0EIjfpMr6eAzwZSMXNZDEMIcCRh89ykKsbIi4vb7vd5j+96B7kOumIoI5AuwQl8BoJrEhKBAhIzrvo3Aqzi5l+6/qAHJiwMlXbVQZt3wAlJOz9FSa1LbSyPmN73TX8r6nyTj0xA36lUQNKeFFkMiHPdT5ZXPUlHPk2KJGKIQdE+yGB4QHp3xIoloj8fsCxRPj3ApIlom3I90PI1vOTw8cllybD2lytW0zzZVK+PXwtCH0AVwKibHS7i2Cwm0nIebZvDGxkzE6EK42CVkQOoQsRLHQfbADtB7YqUsH+y7T99eAiFQ72a1enT/DLW6lEPDJcooaCVE5gIQOO15JQJNdGMM8SYxRNILp2w3PgifYa2+Ep2Ovt2w3GoAcNTz6j55bWg6ZC50rCelYtYTKlhHhArNgUfPCmu9XbGL7Z4Lz3z421zdeDrSFfX+9uvd6i+ho2up4O3Bi+WHh+EUoYmUAsQssofweHAJCD70kBEg5LEFTt43tAPJ7g/zOwy9NOzQz6MixNLWiCd3aP2cYmy7galfScj+acoOLz0+X5goyPjITYX6aKUGWOhW9v/23//PAMnpzs//t8/xT+Ql4LrXofMyjFsARVIRbG+oY0DgbccMusyMAdIm2zV4HrKzCIK1snlP6TnVgsl6EqwYogfcmKOmuPV/VUSnwdZy9kW7RbbIDPIMuTMYCnhQWwhUj+qp8konDxYfDkKzYWPBXmZZsBYkqPKB6NLayfACOERUxdz2BYQir7vkSXUPW0k4lo7sXMlc3dmMHIYX1TMDlA88fjpJ+4EpQjM+tZOI2WoGLYH5EGzzW1O6s5jVw6UQ6rJI5IE3CjMeBhLLLQO1gW4Ai3ywLwqIpuilh1dCS4C3C85zS9S3hpn5B3xxnAT0ymTV9ci5B8FsuERyPajWqbAiLBSzSbFgeq6XZViQ/dpMjSVe6ucneVu0/M3fmXJ2EECm+p9VkyB52rcAqDxXOh9TEUPUpXRzW/+0bMb2SLgUNCi/Trh7Nw0AP04rbAE5Wv2B/5Ur6gfH+6H/75ANuP6WY19gIVJD96C4aARCLdJr1nGpOjvKvWF6W91WYgIUDVkhYRUNOwiS4ZB5eZUinUhNsWS7Ww6ifHxhzwkUNGWOsREKWqNPY9+qqTXHWSq2q0qkY/TDVadZKr3F3l7t8zd7/YSU61omwJfZIt8xy/F6BIC+/RWs6AgFWH8WyacrRV890KMmPTHitqdg7RoLc2WBtuJmIj5Rvpm/WtYS950+OvN9c21wYbvc2oXusvZnk8TbJmTtX22+8juRiauGvo40oFwWWd1mnz+A/ca8QQYQ2hZ9o3g8/BpVfT3rG3tdg7nmnN3nE1qTok2+gh1cxHiGlAmyOtqWiBgLMR4KJiAFUS9MJQkrkALgaChmUyl5S8aAXwNZO4P3Rgik+UKsimUqRKshI0JCTINHbNGgJLgpFiiD0fcKAOdgTo/BW703x2+PvsTp6doMWHaDHbv02EwESfdu6vl53vHoDyBjHi1G/wAwe9ftrhCgIABgKPWdO+c9Wfr/rzVY1f1fgfo8av+vNV7q5y9++Zu/9Hfx66oYf7cyB4cn8OtO0um/ZSb+liyvdu0ylVggYU3kwnSWnouLnqwamvgFBChQptCUQ4XhiKOtVNG7w14bt9r0dpMng9dq6w253OHWwPbMt9mxeyDagFO+QmSt/gXYrO9foSsMFbAT6xwgUbPGTGK5JeSJucaiTGrQc5EuBd7G/4QIRWVza+yL+6MzTRJcAasWkxiPEQQ/QY1CxggPjJEnWbYmbBRrDt3GT3j9nz2/qX7PBMHrBjmfu+KAvoGV4zaZqH6l/N7oKdYqftpS/cCJtVD5zOegvCjpCsx3YENzAG+C8sXvz64ewlG2F/SfldWmxthcSBADLkGEKE8KtfHd7jIiopRpejMSneb3w9gvnChhkYzC7VqRDs4iA44T0A+wkgMbkUFwlKflx19aLamVRciwxrXrtxiacjU9UBD3V4Y91Lqm80CNTuyrQvVcz2JMKOxDqNNMFEmuvYRVHZxWt2PVeJf1TcYs8tJm725ZwW3rUXib9uk0DSIgueWfLWs4V7fnGNH05N8AS5zuuAngh6NL/USqpde7YeDX4x8mvqcak+jCUUz+Yy5rGKWah9WcoOWDLW2oqfGcPQwTS4GJWQRc9W6waFxpQRca9bUyn2ImMZQytI+h1CYigfTHyApZg6EQ1Nmkp9Sn6knYWc/wiDcso+NmymxxdQMZEy1Yl9ts4oMEaBsccAG/T3BQkDC3IbbSAc8AGwO9t/QoKgaA3zPK+lqE7sO7QGS0MCqhIXW2z7D9szgAt/MXqB1FMagGDspKdf8+E99sALq1LDWdUZwLwHF/Wlm3BzfvP6Ts+gsED+1exFi/uzo5IjlU2+Nko/gCR/Hdz9kxBvhTQ/ItKE3hbDjcSGIaAe5L5bWzy4w5PlsYB/4S1lKjXRMKL4K/vYw9TZFBl3GNOU08lYChr5C8Eddn4tjCudUx5Cu4vJD4MdMRrRRXoDCnMY0mQG/NrsA8xUKgEX4zyFlySA6ycdBqtT8PIx/Yhor9o4aKDyvFT4wyBQoswZh/B4ZHdTaZPSgxCMV0pUlmlq46arqozEsEFXtGmyMLk9GuLZMIydtU18RBbsoQ0Hw+DI2a3/aGbIicgoypCu2X4/xhsiJx6LrKDfgIBaMJ/VJLw7OFvgCMyUBbtgctZm1AmLbAdpgQmOOj4Y1tswx9EvCmA2gvGzxtf/+GL+Z1zz4XQ3Owz/E34LFmoHNv2dAk+n0JTSDyF+zLuIZmMeDA5jHAHh4d0dnlrgzHOPj2Fax5H44mo20uAnYOZPL2gu/Cxwag7H5fHZhOpfGI+X/tYMBy2/yB+K1MgXvjbAqWY6qB4f4fFQNAg/ccv9zI2MiW9r9qdXkj9QSsMfSHR//z8tfJp+
sidebar_class_name: "post api-method"
info_path: docs/api/v3/identitynow-v-3-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 'Create a branding item' (create-branding-item)"
---

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"}>Create a branding item</h1>

<MethodEndpoint method={"post"} path={"/brandings"}></MethodEndpoint>



This API endpoint creates a branding item.
A token with API, ORG_ADMIN authority is required to call this API.

## Request

<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"multipart/form-data"} value={"multipart/form-data-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={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"name of branding item","example":"custom-branding-item"}}></SchemaItem><SchemaItem collapsible={false} name={"productName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"product name","example":"product name","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"actionButtonColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"hex value of color for action button","example":"0074D9"}}></SchemaItem><SchemaItem collapsible={false} name={"activeLinkColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"hex value of color for link","example":"011E69"}}></SchemaItem><SchemaItem collapsible={false} name={"navigationColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"hex value of color for navigation bar","example":"011E69"}}></SchemaItem><SchemaItem collapsible={false} name={"emailFromAddress"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"email from address","example":"no-reply@sailpoint.com"}}></SchemaItem><SchemaItem collapsible={false} name={"loginInformationalMessage"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"login information message","example":""}}></SchemaItem><SchemaItem collapsible={false} name={"fileStandard"} required={false} schemaName={"binary"} qualifierMessage={undefined} schema={{"type":"string","format":"binary","description":"png file with logo","example":"\\x00\\x00\\x00\\x02"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"201"} value={"201"}><div>

Branding item 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={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"name of branding item","example":"default"}}></SchemaItem><SchemaItem collapsible={false} name={"productName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"product name","example":"product name","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"actionButtonColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"hex value of color for action button","example":"0074D9","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"activeLinkColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"hex value of color for link","example":"011E69","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"navigationColor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"hex value of color for navigation bar","example":"011E69","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"emailFromAddress"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"email from address","example":"no-reply@sailpoint.com","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"standardLogoURL"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"url to standard logo","example":"","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"loginInformationalMessage"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"login information message","example":"","nullable":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"name\": \"default\",\n  \"productName\": \"product name\",\n  \"actionButtonColor\": \"0074D9\",\n  \"activeLinkColor\": \"011E69\",\n  \"navigationColor\": \"011E69\",\n  \"emailFromAddress\": \"no-reply@sailpoint.com\",\n  \"standardLogoURL\": \"\",\n  \"loginInformationalMessage\": \"\"\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>