> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/system-bo-api/prohibited-word-management.md).
# Prohibited Word Management
## Retrieve Prohibited Word Multilingual List
> \## Function Description\
> \* Retrieves the multilingual list of prohibited words.\
> \---\
> \## Detailed Description\
> \* The default language retrieves the multilingual list selected based on the dataLangCd selected in the GNB.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"BadWordMgmtMlRequest":{"type":"object","description":"Prohibited Word Multilingual Retrieval/Registration/Modification Request","properties":{"bwSeq":{"type":"string","description":"Prohibited Word Sequence No."},"bwNm":{"type":"string","description":"Prohibited Word Name"},"bwDesc":{"type":"string","description":"Prohibited Word Description"},"items":{"type":"array","description":"List of Prohibited Word Numbers to Retrieve","items":{"type":"string"}}},"required":["bwSeq"]},"RealGridListResponseBadWordMgmtMlResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtMlResponse"}}}},"BadWordMgmtMlResponse":{"type":"object","description":"Prohibited Word Multilingual Retrieval Response","properties":{"langCd":{"type":"string","description":"Language Code"},"bwSeq":{"type":"string","description":"Prohibited Word Sequence No."},"bwNmKo":{"type":"string","description":"Native Language Prohibited Word Name"},"bwNm":{"type":"string","description":"Multilingual Prohibited Word Name"},"bwDescKo":{"type":"string","description":"Native Language Prohibited Word Description"},"bwDesc":{"type":"string","description":"Multilingual Prohibited Word Description"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/badWordMgmt/getBadWordMlList":{"post":{"tags":["Prohibited Word Management"],"summary":"Retrieve Prohibited Word Multilingual List","description":"## Function Description\n* Retrieves the multilingual list of prohibited words.\n---\n## Detailed Description\n* The default language retrieves the multilingual list selected based on the dataLangCd selected in the GNB.\n","operationId":"getBadWordMlList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadWordMgmtMlRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseBadWordMgmtMlResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Save/Modify/Delete Prohibited Word
> \## Function Description\
> \* Saves, modifies, and deletes the prohibited word list passed from the screen.\
> \---\
> \## Detailed Description\
> \* Prohibited Word Name (bwNm) and Usage Status (useYn) are required when registering a prohibited word.\
> \* Prohibited Word Sequence No. (bwSeq), Prohibited Word Name (bwNm), and Usage Status (useYn) are required when modifying a prohibited word.\
> \* Prohibited Word Sequence No. (bwSeq) is required when deleting a prohibited word.\
> \* When registering or modifying a prohibited word, it is saved with the dataLangCd selected in the GNB.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridCUDRequestBadWordMgmtRequest":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtRequest"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtRequest"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtRequest"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtRequest"}}}},"BadWordMgmtRequest":{"type":"object","description":"Prohibited Word Registration/Modification/Deletion Request","properties":{"bwSeq":{"type":"string","description":"Prohibited Word Sequence No."},"bwNm":{"type":"string","description":"Prohibited Word Name"},"bwDesc":{"type":"string","description":"Prohibited Word Description"},"useYn":{"type":"string","description":"Usage Status"}},"required":["bwNm","useYn"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/badWordMgmt/saveBadWord":{"post":{"tags":["Prohibited Word Management"],"summary":"Save/Modify/Delete Prohibited Word","description":"## Function Description\n* Saves, modifies, and deletes the prohibited word list passed from the screen.\n---\n## Detailed Description\n* Prohibited Word Name (bwNm) and Usage Status (useYn) are required when registering a prohibited word.\n* Prohibited Word Sequence No. (bwSeq), Prohibited Word Name (bwNm), and Usage Status (useYn) are required when modifying a prohibited word.\n* Prohibited Word Sequence No. (bwSeq) is required when deleting a prohibited word.\n* When registering or modifying a prohibited word, it is saved with the dataLangCd selected in the GNB.\n","operationId":"saveBadWord","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestBadWordMgmtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Register/Modify Prohibited Word Multilingual
> \## Function Description\
> \* Registers and modifies prohibited word multilingual information.\
> \---\
> \## Detailed Description\
> \* If a prohibited word registered with the given prohibited word sequence number and language code exists, the multilingual prohibited word is modified.\
> \* If no prohibited word registered with the given prohibited word sequence number and language code exists, a new multilingual prohibited word is registered.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridCUDRequestBadWordMgmtMlRequest":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtMlRequest"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtMlRequest"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtMlRequest"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtMlRequest"}}}},"BadWordMgmtMlRequest":{"type":"object","description":"Prohibited Word Multilingual Retrieval/Registration/Modification Request","properties":{"bwSeq":{"type":"string","description":"Prohibited Word Sequence No."},"bwNm":{"type":"string","description":"Prohibited Word Name"},"bwDesc":{"type":"string","description":"Prohibited Word Description"},"items":{"type":"array","description":"List of Prohibited Word Numbers to Retrieve","items":{"type":"string"}}},"required":["bwSeq"]},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/badWordMgmt/saveBadWordMl":{"post":{"tags":["Prohibited Word Management"],"summary":"Register/Modify Prohibited Word Multilingual","description":"## Function Description\n* Registers and modifies prohibited word multilingual information.\n---\n## Detailed Description\n* If a prohibited word registered with the given prohibited word sequence number and language code exists, the multilingual prohibited word is modified.\n* If no prohibited word registered with the given prohibited word sequence number and language code exists, a new multilingual prohibited word is registered.\n","operationId":"saveBadWordMl","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestBadWordMgmtMlRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Prohibited Word List
> \## Function Description\
> \* Retrieves prohibited words matching the prohibited word name and usage status conditions passed from the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the list of prohibited words and their descriptions matching the prohibited word name and usage status conditions passed from the screen.\
> \* Uses the dataLangCd cookie value selected in the GNB as the retrieval language.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"BadWordMgmtRequest":{"type":"object","description":"Prohibited Word Registration/Modification/Deletion Request","properties":{"bwSeq":{"type":"string","description":"Prohibited Word Sequence No."},"bwNm":{"type":"string","description":"Prohibited Word Name"},"bwDesc":{"type":"string","description":"Prohibited Word Description"},"useYn":{"type":"string","description":"Usage Status"}},"required":["bwNm","useYn"]},"RealGridListResponseBadWordMgmtResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/BadWordMgmtResponse"}}}},"BadWordMgmtResponse":{"type":"object","description":"Prohibited Word Management Retrieval Response","properties":{"bwSeq":{"type":"string","description":"Prohibited Word Sequence No."},"bwNm":{"type":"string","description":"Prohibited Word Name"},"bwDesc":{"type":"string","description":"Prohibited Word Description"},"useYn":{"type":"string","description":"Usage Status"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/badWordMgmt/getBadWordList":{"get":{"tags":["Prohibited Word Management"],"summary":"Retrieve Prohibited Word List","description":"## Function Description\n* Retrieves prohibited words matching the prohibited word name and usage status conditions passed from the screen.\n---\n## Detailed Description\n* Retrieves the list of prohibited words and their descriptions matching the prohibited word name and usage status conditions passed from the screen.\n* Uses the dataLangCd cookie value selected in the GNB as the retrieval language.\n","operationId":"getBadWordList","parameters":[{"name":"badWordMgmtRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/BadWordMgmtRequest"}},{"name":"bwNm","in":"query","description":"Prohibited Word Name","schema":{"type":"string"}},{"name":"useYn","in":"query","description":"Usage Status","schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseBadWordMgmtResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```