developer.sailpoint.com/docs/api/beta/update-workgroup-members.api.mdx

---
id: update-workgroup-members
sidebar_label: Add members to Governance Group
hide_title: true
hide_table_of_contents: true
api: eJztW/tv2zgS/lcI3Q9tg8ivKHHsA+7gNmnXi7bJJQ6KQxLc0hJtcyuROlFq6g3yv9/MkJLlRx5N9+52C2OBriNRw3l+85Gibj2dioznUqth5PW9Io14Lj7p7PM000X6QSRjkRlv1zMiLDKZz73+5a13YUT2RqtcfM0HRT6Da56MVP+mfKx/A0OFd313vevlfGpwwDv9RWSKq1CwdzjGeHAzEibMZIrTw+SjmTRscDpkPIoM00ownbFEZ4IlVg+Wa8bZqqQGYwO481kodiPzGUrYZSdn7/41OPow/Mg4aKhRdQbSM/HvQmYiQkkhj2OWuzkbV+pK/Y2xnZ23Oo71jVRTNpEijpiesGEkVO4kcMU0KcxjN0AqkCJItDB5Y2enEqV4InZ2wHspz+Bnjq5E/+F1sLfyF7h+15PogpSDO1f9MjxCJXCONdNhbGmS18+zQkCkwplIuNe/9fJ5itOYPANrYKT4ypM0xkudsNc+bB3y7mF7r9Vr8VYbfgXtTrvX7okw5N4dhs5Z9FpHcxS3rNR7aXJUS1rfSEHRGQsMnvXveqSqOMbw8CbdQ0wqleNsPE1jGVJmNn81OOVtzbRv0gWyKBMJ6PJUtZzjeJbxOUYmF4mpOVSPfxVhvh4mlyUvDBtzI0MWiZzL2KDENMM6Q80WctYDdK+8o9EJw8EoSqgiwYIaHh1/HA1H/8Q6WkS2unoHekdPn4QNjxorKdKFFOHBwYTzSIig1T6YjAPRah+GndZB0MEJbB5/gx2RNGnM5wwfXJ7ugwxnXMTM/d9ABt7V7l9Wk1QGWvu84CDgojuedHttEfQm0bgbHLQOeEcE/LB3sLfvlWp6gyiSgp0ngBEeIZPMaerXRfx5FfHObOqjFneYpibVytjgdVrd+zPQJhxXEVM6d3/VslIqSMDH8++ZZYCG4Jz3T3DmDPmWJF9OXZtTmwIMYJjVinCOuDhGjezkpFiJkYvpN4DToxGFiJic54VZV+VKjQAmfxqNTlkZNGbHslBHCNJ5kSkIygRAAaBcqkh+kVEBYO7UzGc8LzsFqFoOhdzBKVhUoL4AIuPS2VUDpRbCnj3/WtDWlIhELKqJsMV0Wm3GmL/cn2zOYaI9nGdWRNDqrYuIM8GjeekRiOl647lSD8YQNMMwLQVnNVY/FQl4AKfi47hyU20M1RHWApeKnO6CAM4KLfsAO8ExCbejx7rImSnCUBiDoD8B9C0gDEzk4WMKoy++w40XimyA0UbkzIHITKZL7OHK2+sEQbQ/6UStIAi6Qe9wv9Oa7AfhQfewx8Xe3pXHNk145U0OW+MxP9zze4dh4Aci7PiH7fDQ3+vuha2W6B0c7I2vvL86IhKTQ2j+MpbiKyhr0AsW0Mq+i8zNq+qphooriAjgOQSE8FZA+akQXNYrJca9PaiiDo8g5N39eiIGgq4l0DkAD1qt9fx7E0uYlx1nGeSKD9joSlNO6nyOjYH+YEZI9YXHMvomfH4YSy0/eAO48HgTfSuV8KcZVAJoKEhlAhSQCPiB1UFE2Yos6SKNW+6z4IlGm73mEXMtjr1xxoCb8oyHn0HW8AnE4UJJeJ6VjwDsE0bdM63oCj4+aPU6wQSShXcOg3Z3f9yb8D3gn/u9Hs6eQNnyaZ0hVc1peep3QokM+FWsgcLL3wT2FQ6+JwVo8qf3M5LxBP8jrNuxlZlOX4ZAtAsd4fWbUxZ0WczVtKDrfLriBOVfnCMfKeIY4cKyXrDcCj7J5FSqjcTdUb6j47eDi/cjuHJ2/I+L43P4hbLWFlID21ggLTXB90zfkMbOgBtuAKZicIeIGmzHSd0Bg7gy9YHS/mXm0IISyK0JL+IcnnCzb3iiLppNMp0slVKJ2i9lQzR2gaDDNQDvcIaEGYm6XUntDADC09x/7zy5w2aAYSJ71WCDRQuAagSh8Px8wfTdUmxSQCkLWg1iSwAqJsMVvrlw5XI0FsDyvh4ULA7Q/PE8GYQ5NnMys16FVbY4FV18QGfruWXtRjWnkUvn0ARDsAKWrHNwY5aBh4GCQAPMDXNwhOEyADyqHFchFkJgaRbB3QerzFGu6V7IC/OEujuNAX58Mq268UW44qMll0UjUe/UDpHgJppND7tRVbjKwrfr6W3tbmt3W7tPrN3VmyXvcXeJ+rTXqQ/QVbsrhs1zjfpklD1Kl1tnv1l+bQO5i8zaUaSfP43cxhuMF19TpJS/Iz+yrXxN+UEVD3t9jPSjCtZSLFBB8qO1ABcEIuqT3guNyVHWVXvrs73V2VhCgqoNFBFQM2NzXTAOLssKZVcpZpdFWhj1ImczDvjI7YKEEBBnVZGfalhZbJnklkluu9G2G/043WjLJLe1u63dP2ftPsgkK62oWhxPMkWS8GxuM83dp3cgDAYstr+rkqNQrbIVFMYqjuUtMwdv3GmP25NuKIKIB9HBXm/SCQ86fL/b7rbHQafr1Xv95aKOqyJbrqlavG0cycVA4r4AjysUJJfJtY6Wt//AvZmYIKzR28OSN4PPcSOy4o6d3jp3HGnNPnA1LxmSWeKQauEjxDQYm+DYrBwLAzibAi4qBlAlNb2KzmUiQEoGScNimUgqXrQC5GZzfzDJwRRbKIsX024WqcK4AA0JCWKNrFlDYkkwUkyQ84EEYrBTQOffkZ26EH0Xk2dnaPF7tJgdfw2FwEKvmPv+pv3dISifIUac2wDfs9FrVztcQQLAgsBiVsU7t/x8y8+3PX7b43+MHr/l59va3dbun7N2v4GfOzZ0Pz+HAU/m5zC20WIVl3qLyfU/p+lUKk4DSm+mw7DIaLu55ODEKyCVUKFUGwIRPE3Z95rVQUvTvK0durxrumMFTTzM40Ny4kkFIotWzyKL4fFZnqem32zeQvggbHcNnspGecpJ6ZtGqJPmGHy2AY7w3IAtPRxAh1vtBA1yeCYxpy0AknDrfjIRsxfCQFvFD0rG420Y17kuAPJIzC6eFnT5RZdBxRQWFy+MO3qH7lqzD+y6yOK777fFCrrHlk3ue3A2GM9A0xUT0YTrxbnkc2Tidva108mL7oKrt87aZCc4rMNeC57hATB6ofHy50+jV2yK/JPqvzBIfYXEBQNU0CmkCOHboNzcx4eo5UBuTWek+GDp9QnWE5vEYDC7UudCsMvy3MtHAP4zQGpyKT4kCBzwqeuXZXQi8UXE2BMbC09i4slINcFDTb703Cvqf7RQqB2Ralwpnx1JhCU8H0RjnIn2UNtlWtrFa3Y9V4m/lNJ8K80naebVihbWtZehPY4TQlGjCB4b8tazJ7fy/Jo8XFXBFZS6qgN6wumx/NIrLKP2bD2W5Pkob1mPK/VpJqG5Lj/GLJYxA70xjtiQhTOtjfg7Y5g6WAaX0wKq6Nlq3eCkPlWE32nVVPLtlL70gSqSfu+hMJRNJnvGjpiKBhKnIluSv1BkoeZ/oTN7vyzZTJcvoaPiyEiH5tk644Q+TuhbDDBOf3fQ+hWd8UMbCAdsArxZxJ+QwClawz0rayOqk/gmPYOtIQRVSYpJ+/aP/gLg3C9GN3B0NQZgGJl29RoQvztwsrBrLTmr3CNY9eC6vrGGZrniN6tvtUeFDfSPZi9aPFhspZyoeP57o/Q9SPLHwd3/E+JtkeZHRBrHfXFL8mzxwc7xf/PLCUxtMtEtSOoF9dpxw/VtRNznngn4F+4SLhClhwWT/WwLGVNdUBrzHCuIECScSUEbEKngOfLMXcxinVDVp5lGqIFlJgmaZjAGIMIA/+VjGYM82iIvZ+ZUnJbEYg7h36agVRB9FjaDBa1osE+wJlQhpACuB/GQB9z7VbuF4TlkwSkmETsqEwsIXpIUCs8xg9pFwjik7yPZF0kTFhYkYXmoROkLTTSzeqpEDExrNIG+nxBZYk4muLcNy+Zakj0yF+SYcRvb4HqMogvywpCz8gA5jFteIjwmGzLbn4k4xRUpILzAE9iLGT4MR2sSQZgyYBes/HU2bbqHTBPHghBcitn02Wu0Gy2fliZwHRd4sIauCYccrX8muHqCfDUdbxdb+z/wd4eu8nEp1ExxTw99V9ilmV0cXy6+QsRw95e/SUyq7z+rFTKU/wxX1/Dk7S1uCOGS8Q4vgxq423B5vVgNEvxAcuBvgJwJQKN4IBAvz5ybXrGHv3ncaFe5o6nmi80MD35+FrgHUjfs7hqG290q0tCOcK9H/NGc+EwpYe29D66c7RN2B+zBsde1XYnTE9wL9Mbue8rEbrBk/AYu4r997wr+gz9soAn/6fqtV25XwhgrtySOm3iT+wGRgGH/AYFO3z0=
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 'Add members to Governance Group' (update-workgroup-members)"
---

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 Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Add members to Governance Group</h1>

<MethodEndpoint method={"post"} path={"/workgroups/{workgroupId}/members/bulk-add"}></MethodEndpoint>



This API adds one or more members to a Governance Group.  A token with API, ORG_ADMIN authority is required to call this API.

>  **Following field of Identity is an optional field in the request.**

>  **name**

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"workgroupId","in":"path","description":"ID of the Governance Group.","required":true,"schema":{"type":"string","example":"2c91808a7813090a017814121919ecca"}}}></ParamsItem></ul></div></details><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"}}>

List of identities to be added to a Governance Group members list.

</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><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Identity's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity ID.","example":"2c7180a46faadee4016fb4e018c20642"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity's display name.","example":"Michael Michaels"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"207"} value={"207"}><div>

List of added and not added identities into  Governance Group members list.

</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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Identifier of identity in bulk member add request.","type":"string","example":"464ae7bf791e49fdb74606a2e4a89635"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"\nThe HTTP response status code returned for an individual member that is requested for addition during a bulk add operation.\n\n The HTTP response status code returned for an individual Governance Group is requested for deletion.\n\n\n> 201   - Identity is added into Governance Group members list.\n\n> 409   - Identity is already member of  Governance Group.\n","type":"string","example":"201"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Human readable status description and containing additional context information about success or failures etc.\n","type":"string","example":"\n> Identity is added into Governance Group members list.\n\n> Unable to set Membership of Identity \"3244d5f2d04447498520f54c6789ae33\" to Governance Group \"f80bba83-98c4-4ec2-81c8-373c00e9663b\"; the relationship already exists.\n"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n  {\n    \"id\": \"464ae7bf791e49fdb74606a2e4a89635\",\n    \"status\": \"201\",\n    \"description\": \"Identity added to Governance Group members list.\"\n  }\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"}><Markdown> An example of a 403 response object</Markdown><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"}><Markdown> An example of a 500 response object</Markdown><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>