---
id: create-notification-template
sidebar_label: Create Notification Template
hide_title: true
hide_table_of_contents: true
api: eJztXP9T2zgW/1c0vs7sthObEEI5+OFuUkr32KOFgzCdu8B0FVtJ1DqST7KhOYb//d57kh2HGOh22d3ujlsGYlt6et/fR5KVm0BnwvBcanWYBHtBbATPxTudy4mM6fZQzLMU7gWdIOdTG+yNgvpjG1x2gkTY2MgMr4HGcCYtc4Qs4yz3BNhEG7bQhWFW5iJiF+pC/VsXLOaK8dRqVljBcuwrVJJpqXKWw80swb5LMhFjb6SxeYfFOltAB8GMsBlwIthYJws2MXpOt0dTkTNV43XJSjnC5fezPM/s3sZGIq5EirqILJcpPYxiPd+QidrgmdwYi5xvAMGwTjAsCT4n4WqygpzsWtpZXQSVsIxb+CRzBuS15/2/hbC5Zx2IrGgAhGVvdSInTtCJFGliHXHu9BPPuJo64rYYz4E0Njw5PhtWpK9nQsEFTxYRGNGKuDAyX4Ahb4JzK8y+Vrn4nA+KfIbGBYH3GmW0e86mweUtmNwTfwVsB3s3dCmNABfKTSE6QYxEVY6PeJalntbGR4sechPYeCbmHD/li0yAz+jxRxHnwF5m0Ai5FBaffhKLWiObG6mm0Eh85sAT3opTXSQf5lwVPP1wrc2nD+Bb8w+2mM+5WQTrrikY0GR6QmoqRQtuO4Hic/HwWENuP7G3XPGpMOysGC8JNw2D9Mpx7u8JA89FIot509DrROfCWiDCXJ8IfMOUF5bN+YKNwRWSRCTgYM5jirwwAu0uFA4yCg7eDg6P4PrkH8fvDuDv2dsz/H002P8n/B0eDOD6si626wCMpjrmaaOO1hl1bb1DL/lGR+tAnLzaP2H9HZaC7xZ0n0+jFV0LUg14NLnFg2bBHDLjV4I9AwnHwhxPTiB8oBVq3bJnOfxxHzFcNPbCGFTs2c2HD9NUj3kagdclRZy/A5vdRo0CeVZYKpUolVt3nxnElzBNnKoiTfkYWXWhUXGOD3CozAgIj2XsrA/uiLMrnhYwuIWkdk0ahk6QZSBjOH5cDsEcEbHDCXAZp0Xim0AfFeKIjortwF24gNRZpJiOwCj9bjdCUcY+pu9X+UkqOKTbqWY+i6GOwf/IwRvVR6w1qG2idf6rqc0R/63UhnXnYbU9q/wNkp9M30CHQZIALduos4sAW+xdBBjS2KpJgUZk6WKon3jgU6TKhhrGvs/hV7o9NPhrGHHBEjnFWhQyC2WByQlzwYoZUhe5zTmFLDmSdWkDXUpfK2jzN9Zt5LN2p4lDmTxSOzZ3xoJv8XB7p5+E/e2tONwV3X7Y33q5PRlPtvmkO24YFxwJfniR63AqFIInkZADuPLYOCgINOeQxwJEAmEu56JRIHzgyjWhgApNVHgKPPQ+BuqS9bq9btjdhJ9ht7tHP1GX/v2HKg4iCvmrcHrNLWR1MHQ5xhMwfNupwYsRYYKqalZVCUpWLnNXpz0zr3MNnV13BxAJU/S6XfyzKtNgKYKDIqtoNWgRTYtoWkTTIpoW0bSIpkU0LaL5vRFNvwnE7KcSXfHAGPC2kJ0KqJQKK+dkfakJJVCQASTx/UTgJhE5hMa+Tr6gpr6BKAynhkvkUBDLMXRkQPFKUuTMEQo4kiXsoHarisZktcle8QTkdfLte2FATbnh8SegddjoGasMnSsJ/VnZhcmkKvYNw4odwccvu7u9/uRln/PeX/ubO9vj3Qnf2urubu/uOhxEGMHWxubG8HUQ9wP6kIwdxpD/A4VAbIDuiQEaHLogDLSP2+C3xTTh+dlaZauA1bGRU9mcSz10e33wZnB+NIQ7pwf/Oj84g09Ia21JeYDpMEG31JRgZ1D38qUAGKNWpKAODM8XnuoLEIgrW28o3ZVdWFAm+NaEQ9GDHn70hh510sul5TKUYrd2yr6XkYg6gFUxT/A8nrExwImEaZfDXwziWGR5eOQ1+cLjn+cRg6olUUhe1uMHQC/Vb6gttKgdi1VbLFV5F2eUWeSobhQMDuD8cT8ZxDnMRMgnVqKw8hbPorcP8Ow0t8rdsKY0UulC5TwGKXgKpTTWxiAUHYNsMrfMpyM0l4XEo8p2VcbCFFiKRenurWPGJUjIZ7ywXxB3Jymkn5BEqx5cCR98hK5dNiJrlGbyGanEidjZt6rMVQa+w2Bt7Lax28buF8bu3YenfummDn0216HPuQIwNtOGiuca9DF+ssTKRm470Bmyw0AhHiL9+H4Igf0JQCBuwn3OEKE9IT5ypbxh8am0h7s/pnlDaawVWyCDpEcnwQQykUj2iO8lx6Qop6qt9dHeaDOW4KCqASJC1qRVL8ZBZaZQCjnhMEdMtLDqu9wtS3CICGtdBnSblaHbrWyRZIsk22rUVqM/TTVqkWQbu23s/jFj90EkWXFF0eJxUrnHRp7mn6O0uCK+tXzLrAo5MtVdtILEWIWxglXkEIx7m+PNyU4s+gnvJy+3die9+GWPb+9s7myO+72doF7rR8s4roJsNaZq9nZ2dDs7wlwBjisUOJfNtU5Wl/9AvUZMMK1h6qlwM+gcVHpZYcfe7jp2HGqNu36LEiHZFQypljrCnAZt59jWlG1pc2EKeVExSFUS+EJXwnXXkOESKkvlXPolYYF0zSIcTHDDw28XeSerRvEbG5YyQaoRNWtwLAlCigliPqBACHYK2fkJ0ak30S9C8uwUJT5CidnB51gIDPQKuW83re8eAvMGc8SZM/A9C71utsMVOABMCFzOqnBni89bfN7W+LbG/zlqfIvP29htY/ePGbs/A597NHQ/PocGX4zPt3EnnlVY6g06128O0ylUPAfk3kzHcWFoubnE4IQrwJWQoUxbSiIcD2kEG80HNAI83YHI0DFVmBTalgdcbsBWYKPbiGcyghQG5soXSl/TKRc83XLviyH0RhE0YIOTQz+3iEi7RqIDu2xHxJ2uSR501fIgzYOUy7cK6V1LR6bDwNm9M9FtfMcNZhLfWWodkfOsyQdynZv09pfL4gjdI0uT+h4cDdoz4PSOiCjC5fIwzhnCbjf62pGcZSnBqVpvbbBjbNZjrwQ3MCdwuxff//h++JxVr6awwiLOFRJnBxAuJ+AilMwG5Uo+dqL6YnQxnRHjg5W9EgweNklBYHahzoRgo0OvhHeQ5U8hLZNKsZOgTIC9vvx4FV/p545T0axAKvf+DtyNLlTIXkvMQXjwjNp4EWmSx0ZZKRevyfW1TPylpBY6aiFRs8/vcOFUO4rduzcxRDCS4KklbX314I5eWKOHUyi4g1Tv8oCa8Hys7nDFpdW+mo8VeiHSW+XjQr2fSaikq92YS1zMQiFME3bI4pnWVvydMXQdDIPRtIAo+mq2rnHQkCIi7HVrLIVuyFCGgAuJvyMIDOWciY+xLhMs0YDYVOJC8ieyLMT8T3SO7qcVmen2CMontkx0bL+aZxwwxAFDlwOs599VJ3QsfFsNZKA84Bxgf2l/ygSe0Vrec7QaszqR36A+WBpiYJWo2GzPXewtE5z/xOgBtq7aQBpGWF3t+cE187SwRK0oq1wQuKvBdX5TDZXxjt4cv9WCFFbLb01elHiwXDc5VuniqbP0PZnk28m7v1PGazPNnzHTeKCL64+nyyPFB+WUxB+YefxUjDvs8uCJlvJYSnVgpIbag9rRjF/l/IU7gvDoOQP3yv3Dr7dXL8j/nLfgn+qddUnfEvBl75lXr48/+DZ0/e3tx97zxqxE3uknjvVc+MrD+vXlXvpeAQG/4SnZjKZeMLF1ByLQDHVCOJnC5EfJP55JQQtFGciCU4QOvfY9p4QNRsYqIawjNCV5DXg2h6m9TIEebWWUI3PKq27+geGP1+UpnOoof8Te4/cTxBC9OG/Hl3Hg2UftJ/BnYMcT+nKE12VOAGw+nxcKRkOTFXPGIfM8kjgSaePCegdWSpS60DRDqHqVyR4zEooQ0QzWzO3xBPcgZCxq+eGRsSA9WL8Bwd0JKB+zS0FOReq/VKJzZ3b3GG1ISuFMpBmd6gK2lBW1Ed4eDtcoAjFlQa5YRNpMN3wnu4FtgQjOop37bEWbUTekWSXcx4k4hGuN+D5ZndW/FIPVvjTjzqmSav+l/ZqMb/prMjyaw2n4RoaLx2j8wi0LuFWYUXDPKgzM62e4XAMtbm5whRGXJW7xNgyEy1ejy+WKA17VDtuNyoLnt7bC4YLgqV/KWt+zw4UQ18OtXj7Y9rK2ooSyB8ujcXO3OGb4NVYY+L0XXMB/uNCZC0loRPdvgnKpGdo4uuU8oAkG+w8o5u3t/wHVMYkZ
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 'Create Notification Template' (create-notification-template)"
---

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 Notification Template</h1>

<MethodEndpoint method={"post"} path={"/notification-templates"}></MethodEndpoint>



This creates a template for your site. 

You can also use this endpoint to update a template.  First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint.   Modify the fields you want to change and submit the POST request when ready.

## 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={"key"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"cloud_manual_work_item_summary","description":"The key of the template"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Task Manager Subscription","description":"The name of the Task Manager Subscription"}}></SchemaItem><SchemaItem collapsible={false} name={"medium"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`EMAIL`, `PHONE`, `SMS`, `SLACK`, `TEAMS`]"} schema={{"type":"string","description":"The message medium. More mediums may be added in the future.","enum":["EMAIL","PHONE","SMS","SLACK","TEAMS"],"example":"EMAIL"}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en"}}></SchemaItem><SchemaItem collapsible={false} name={"subject"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.","description":"The subject line in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"header"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":null,"deprecated":true,"description":"The header value is now located within the body field. If included with non-null values, will result in a 400."}}></SchemaItem><SchemaItem collapsible={false} name={"body"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Please go to the task manager","description":"The body in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"footer"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":null,"deprecated":true,"description":"The footer value is now located within the body field. If included with non-null values, will result in a 400."}}></SchemaItem><SchemaItem collapsible={false} name={"from"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"$__global.emailFromAddress","description":"The \"From:\" address in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"replyTo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"$__global.emailFromAddress","description":"The \"Reply To\" line in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Daily digest - sent if number of outstanding tasks for task owner > 0","description":"The description in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b","description":"This is auto-generated."}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when this template is created. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when this template was last modified. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

A template object for your site

</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={"key"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"cloud_manual_work_item_summary","description":"The key of the template"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Task Manager Subscription","description":"The name of the Task Manager Subscription"}}></SchemaItem><SchemaItem collapsible={false} name={"medium"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`EMAIL`, `PHONE`, `SMS`, `SLACK`, `TEAMS`]"} schema={{"type":"string","description":"The message medium. More mediums may be added in the future.","enum":["EMAIL","PHONE","SMS","SLACK","TEAMS"],"example":"EMAIL"}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en"}}></SchemaItem><SchemaItem collapsible={false} name={"subject"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.","description":"The subject line in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"header"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":null,"deprecated":true,"description":"The header value is now located within the body field. If included with non-null values, will result in a 400."}}></SchemaItem><SchemaItem collapsible={false} name={"body"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Please go to the task manager","description":"The body in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"footer"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":null,"deprecated":true,"description":"The footer value is now located within the body field. If included with non-null values, will result in a 400."}}></SchemaItem><SchemaItem collapsible={false} name={"from"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"$__global.emailFromAddress","description":"The \"From:\" address in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"replyTo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"$__global.emailFromAddress","description":"The \"Reply To\" line in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Daily digest - sent if number of outstanding tasks for task owner > 0","description":"The description in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b","description":"This is auto-generated."}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when this template is created. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when this template was last modified. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"key\": \"cloud_manual_work_item_summary\",\n  \"name\": \"Task Manager Subscription\",\n  \"medium\": \"EMAIL\",\n  \"locale\": \"en\",\n  \"subject\": \"You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.\",\n  \"body\": \"Please go to the task manager\",\n  \"from\": \"$__global.emailFromAddress\",\n  \"replyTo\": \"$__global.emailFromAddress\",\n  \"description\": \"Daily digest - sent if number of outstanding tasks for task owner > 0\",\n  \"id\": \"c17bea3a-574d-453c-9e04-4365fbf5af0b\",\n  \"created\": \"2020-01-01T00:00:00.000000Z\",\n  \"modified\": \"2020-01-01T00:00:00.000000Z\"\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>