> 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/email-sending-management.md).

# Email Sending Management

## Validates the email information.

>   \## Function Description\
>   \* Validates the email information.\
>   \---\
>   \## Detailed Description\
>   \* Validates the email information.\
> &#x20; \* Validates the email information before modifying it.<br>

```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":{"SendEmailMgmtRequest":{"type":"object","description":"Email Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email Sending No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date-time","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date-time","description":"Search Period End Date"},"emailSndMethCd":{"type":"string","description":"Send Method (CM023)"},"searchCondition":{"type":"string","description":"Search Condition (Email Subject/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"emailSndStatCd":{"type":"string","description":"Send Status (CM022)"},"emailTypCd":{"type":"string","description":"Email Type (CM025)"},"emailTrgmnTypCd":{"type":"string","description":"Recipient Type (CM028)"},"siteNm":{"type":"string","description":"Site Name"},"sndRes":{"type":"string","description":"Send Result"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"emailNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailAddr":{"type":"string","description":"Email Address"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrEmail":{"type":"string","description":"Email Address"},"mbrStatCd":{"type":"string","description":"Member Status"},"emailRecvAgrYn":{"type":"string","description":"Email Receipt Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationEmailCnt":{"type":"integer","format":"int32","description":"Email Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"dateSelect":{"type":"string","description":"Select Search Period"}}},"ResponseString":{"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":{"type":"string","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"}}},"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"}}}}}},"paths":{"/v1/system/sendEmailMgmt/validateSendEmailBaseInfo":{"post":{"tags":["Email Sending Management"],"summary":"Validates the email information.","description":"  ## Function Description\n  * Validates the email information.\n  ---\n  ## Detailed Description\n  * Validates the email information.\n  * Validates the email information before modifying it.\n","operationId":"validateSendEmailBaseInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailMgmtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Validates the email sending target information.

> &#x20; \## Function Description\
> &#x20; \* Validates the email sending target information.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Validates the email sending target information.\
> &#x20; \* Checks whether the target is already a registered member before registering the email sending target information.<br>

```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":{"SendEmailMgmtRequest":{"type":"object","description":"Email Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email Sending No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date-time","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date-time","description":"Search Period End Date"},"emailSndMethCd":{"type":"string","description":"Send Method (CM023)"},"searchCondition":{"type":"string","description":"Search Condition (Email Subject/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"emailSndStatCd":{"type":"string","description":"Send Status (CM022)"},"emailTypCd":{"type":"string","description":"Email Type (CM025)"},"emailTrgmnTypCd":{"type":"string","description":"Recipient Type (CM028)"},"siteNm":{"type":"string","description":"Site Name"},"sndRes":{"type":"string","description":"Send Result"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"emailNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailAddr":{"type":"string","description":"Email Address"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrEmail":{"type":"string","description":"Email Address"},"mbrStatCd":{"type":"string","description":"Member Status"},"emailRecvAgrYn":{"type":"string","description":"Email Receipt Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationEmailCnt":{"type":"integer","format":"int32","description":"Email Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"dateSelect":{"type":"string","description":"Select Search Period"}}},"ResponseString":{"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":{"type":"string","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"}}},"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"}}}}}},"paths":{"/v1/system/sendEmailMgmt/validateInsertSendEmailTargetMember":{"post":{"tags":["Email Sending Management"],"summary":"Validates the email sending target information.","description":"  ## Function Description\n  * Validates the email sending target information.\n  ---\n  ## Detailed Description\n  * Validates the email sending target information.\n  * Checks whether the target is already a registered member before registering the email sending target information.\n","operationId":"validateInsertSendEmailTargetMember","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SendEmailMgmtRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Sends a test email.

> &#x20; \## Function Description\
> &#x20; \* Sends a test email.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Sends a test email.<br>

```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":{"SendEmailMgmtRequest":{"type":"object","description":"Email Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email Sending No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date-time","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date-time","description":"Search Period End Date"},"emailSndMethCd":{"type":"string","description":"Send Method (CM023)"},"searchCondition":{"type":"string","description":"Search Condition (Email Subject/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"emailSndStatCd":{"type":"string","description":"Send Status (CM022)"},"emailTypCd":{"type":"string","description":"Email Type (CM025)"},"emailTrgmnTypCd":{"type":"string","description":"Recipient Type (CM028)"},"siteNm":{"type":"string","description":"Site Name"},"sndRes":{"type":"string","description":"Send Result"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"emailNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailAddr":{"type":"string","description":"Email Address"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrEmail":{"type":"string","description":"Email Address"},"mbrStatCd":{"type":"string","description":"Member Status"},"emailRecvAgrYn":{"type":"string","description":"Email Receipt Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationEmailCnt":{"type":"integer","format":"int32","description":"Email Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"dateSelect":{"type":"string","description":"Select Search Period"}}},"ResponseString":{"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":{"type":"string","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"}}},"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"}}}}}},"paths":{"/v1/system/sendEmailMgmt/sendTestEmail":{"post":{"tags":["Email Sending Management"],"summary":"Sends a test email.","description":"  ## Function Description\n  * Sends a test email.\n  ---\n  ## Detailed Description\n  * Sends a test email.\n","operationId":"sendTestEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailMgmtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Register Email Receiving Target

> &#x20;   \## Function Description\
> &#x20;   \* Saves the data when bulk-registering recipients.\
> &#x20;   \---\
> &#x20;   \## Detailed Description\
> &#x20;   \* When recipients are bulk-registered, the send status is initially saved as 'N'.<br>

```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":{"SendEmailMgmtRequest":{"type":"object","description":"Email Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email Sending No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date-time","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date-time","description":"Search Period End Date"},"emailSndMethCd":{"type":"string","description":"Send Method (CM023)"},"searchCondition":{"type":"string","description":"Search Condition (Email Subject/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"emailSndStatCd":{"type":"string","description":"Send Status (CM022)"},"emailTypCd":{"type":"string","description":"Email Type (CM025)"},"emailTrgmnTypCd":{"type":"string","description":"Recipient Type (CM028)"},"siteNm":{"type":"string","description":"Site Name"},"sndRes":{"type":"string","description":"Send Result"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"emailNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailAddr":{"type":"string","description":"Email Address"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrEmail":{"type":"string","description":"Email Address"},"mbrStatCd":{"type":"string","description":"Member Status"},"emailRecvAgrYn":{"type":"string","description":"Email Receipt Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationEmailCnt":{"type":"integer","format":"int32","description":"Email Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"dateSelect":{"type":"string","description":"Select Search Period"}}},"ResponseInteger":{"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":{"type":"integer","format":"int32","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"}}},"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"}}}}}},"paths":{"/v1/system/sendEmailMgmt/saveStEmailTgtMbrInfoExcel":{"post":{"tags":["Email Sending Management"],"summary":"Register Email Receiving Target","description":"    ## Function Description\n    * Saves the data when bulk-registering recipients.\n    ---\n    ## Detailed Description\n    * When recipients are bulk-registered, the send status is initially saved as 'N'.\n","operationId":"saveStEmailTgtMbrInfoExcel","parameters":[{"name":"emailSndNo","in":"query","description":"Email Send No.","required":true,"schema":{"type":"String"}},{"name":"mbrId","in":"query","description":"Member ID","required":true,"schema":{"type":"String"}},{"name":"applyYn","in":"query","description":"Application Status","required":true,"schema":{"type":"String"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SendEmailMgmtRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseInteger"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Registers the email target member.

> &#x20; \## Function Description\
> &#x20; \* Registers the email target member.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Registers the email target member.\
> &#x20; \* Registers member information not yet registered for the email.<br>

```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":{"SendEmailMgmtRequest":{"type":"object","description":"Email Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email Sending No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date-time","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date-time","description":"Search Period End Date"},"emailSndMethCd":{"type":"string","description":"Send Method (CM023)"},"searchCondition":{"type":"string","description":"Search Condition (Email Subject/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"emailSndStatCd":{"type":"string","description":"Send Status (CM022)"},"emailTypCd":{"type":"string","description":"Email Type (CM025)"},"emailTrgmnTypCd":{"type":"string","description":"Recipient Type (CM028)"},"siteNm":{"type":"string","description":"Site Name"},"sndRes":{"type":"string","description":"Send Result"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"emailNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailAddr":{"type":"string","description":"Email Address"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrEmail":{"type":"string","description":"Email Address"},"mbrStatCd":{"type":"string","description":"Member Status"},"emailRecvAgrYn":{"type":"string","description":"Email Receipt Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationEmailCnt":{"type":"integer","format":"int32","description":"Email Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"dateSelect":{"type":"string","description":"Select Search Period"}}},"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/sendEmailMgmt/insertSendEmailTargetMember":{"post":{"tags":["Email Sending Management"],"summary":"Registers the email target member.","description":"  ## Function Description\n  * Registers the email target member.\n  ---\n  ## Detailed Description\n  * Registers the email target member.\n  * Registers member information not yet registered for the email.\n","operationId":"insertSendEmailTargetMember","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SendEmailMgmtRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Registers/modifies the email basic information.

> &#x20; \## Function Description\
> &#x20; \* Registers/modifies the email basic information.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Registers/modifies the email basic information.\
> &#x20; \* If the email number to be registered is already registered, it is modified.<br>

```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":{"SendEmailMgmtRequest":{"type":"object","description":"Email Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email Sending No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date-time","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date-time","description":"Search Period End Date"},"emailSndMethCd":{"type":"string","description":"Send Method (CM023)"},"searchCondition":{"type":"string","description":"Search Condition (Email Subject/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"emailSndStatCd":{"type":"string","description":"Send Status (CM022)"},"emailTypCd":{"type":"string","description":"Email Type (CM025)"},"emailTrgmnTypCd":{"type":"string","description":"Recipient Type (CM028)"},"siteNm":{"type":"string","description":"Site Name"},"sndRes":{"type":"string","description":"Send Result"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"emailNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailAddr":{"type":"string","description":"Email Address"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrEmail":{"type":"string","description":"Email Address"},"mbrStatCd":{"type":"string","description":"Member Status"},"emailRecvAgrYn":{"type":"string","description":"Email Receipt Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationEmailCnt":{"type":"integer","format":"int32","description":"Email Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"dateSelect":{"type":"string","description":"Select Search Period"}}},"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/sendEmailMgmt/insertSendEmailBaseInfo":{"post":{"tags":["Email Sending Management"],"summary":"Registers/modifies the email basic information.","description":"  ## Function Description\n  * Registers/modifies the email basic information.\n  ---\n  ## Detailed Description\n  * Registers/modifies the email basic information.\n  * If the email number to be registered is already registered, it is modified.\n","operationId":"insertSendEmailBaseInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendEmailMgmtRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SendEmailMgmtRequest"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Validate Email Receiving Target

> &#x20;   \## Function Description\
> &#x20;   \* Validates the eligibility of target members when bulk-registering recipients.\
> &#x20;   \---\
> &#x20;   \## Detailed Description\
> &#x20;   \* Returns the applyYn, errorCode, and errorMsg results after validating the bulk registration of recipients.<br>

```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":{"SendEmailMgmtRequest":{"type":"object","description":"Email Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email Sending No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date-time","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date-time","description":"Search Period End Date"},"emailSndMethCd":{"type":"string","description":"Send Method (CM023)"},"searchCondition":{"type":"string","description":"Search Condition (Email Subject/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"emailSndStatCd":{"type":"string","description":"Send Status (CM022)"},"emailTypCd":{"type":"string","description":"Email Type (CM025)"},"emailTrgmnTypCd":{"type":"string","description":"Recipient Type (CM028)"},"siteNm":{"type":"string","description":"Site Name"},"sndRes":{"type":"string","description":"Send Result"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"emailNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailAddr":{"type":"string","description":"Email Address"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrEmail":{"type":"string","description":"Email Address"},"mbrStatCd":{"type":"string","description":"Member Status"},"emailRecvAgrYn":{"type":"string","description":"Email Receipt Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationEmailCnt":{"type":"integer","format":"int32","description":"Email Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"dateSelect":{"type":"string","description":"Select Search Period"}}},"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/sendEmailMgmt/getMbrInfoValidation":{"post":{"tags":["Email Sending Management"],"summary":"Validate Email Receiving Target","description":"    ## Function Description\n    * Validates the eligibility of target members when bulk-registering recipients.\n    ---\n    ## Detailed Description\n    * Returns the applyYn, errorCode, and errorMsg results after validating the bulk registration of recipients.\n","operationId":"getMbrInfoValidation_1","parameters":[{"name":"emailSndNo","in":"query","description":"Email Send No.","required":true,"schema":{"type":"String"}},{"name":"mbrId","in":"query","description":"Member ID","required":true,"schema":{"type":"String"}},{"name":"mbrNm","in":"query","description":"Member Name","required":true,"schema":{"type":"String"}},{"name":"validationType","in":"query","description":"Validation Type","required":true,"schema":{"type":"String"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SendEmailMgmtRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SendEmailMgmtRequest"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Deletes the email target member.

> &#x20; \## Function Description\
> &#x20; \* Deletes the email target member.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Deletes the email target member.<br>

```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":{"SendEmailMgmtRequest":{"type":"object","description":"Email Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email Sending No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date-time","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date-time","description":"Search Period End Date"},"emailSndMethCd":{"type":"string","description":"Send Method (CM023)"},"searchCondition":{"type":"string","description":"Search Condition (Email Subject/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"emailSndStatCd":{"type":"string","description":"Send Status (CM022)"},"emailTypCd":{"type":"string","description":"Email Type (CM025)"},"emailTrgmnTypCd":{"type":"string","description":"Recipient Type (CM028)"},"siteNm":{"type":"string","description":"Site Name"},"sndRes":{"type":"string","description":"Send Result"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"emailNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailAddr":{"type":"string","description":"Email Address"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrEmail":{"type":"string","description":"Email Address"},"mbrStatCd":{"type":"string","description":"Member Status"},"emailRecvAgrYn":{"type":"string","description":"Email Receipt Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationEmailCnt":{"type":"integer","format":"int32","description":"Email Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"dateSelect":{"type":"string","description":"Select Search Period"}}},"ResponseString":{"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":{"type":"string","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"}}},"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"}}}}}},"paths":{"/v1/system/sendEmailMgmt/deleteSendEmailTargetMember":{"post":{"tags":["Email Sending Management"],"summary":"Deletes the email target member.","description":"  ## Function Description\n  * Deletes the email target member.\n  ---\n  ## Detailed Description\n  * Deletes the email target member.\n","operationId":"deleteSendEmailTargetMember","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SendEmailMgmtRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Email Recipient Information List

> &#x20; \## Function Description\
> &#x20; \* Retrieves the email recipient list.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Retrieves the email recipient list.<br>

```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":{"SendEmailMgmtRequest":{"type":"object","description":"Email Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email Sending No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date-time","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date-time","description":"Search Period End Date"},"emailSndMethCd":{"type":"string","description":"Send Method (CM023)"},"searchCondition":{"type":"string","description":"Search Condition (Email Subject/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"emailSndStatCd":{"type":"string","description":"Send Status (CM022)"},"emailTypCd":{"type":"string","description":"Email Type (CM025)"},"emailTrgmnTypCd":{"type":"string","description":"Recipient Type (CM028)"},"siteNm":{"type":"string","description":"Site Name"},"sndRes":{"type":"string","description":"Send Result"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"emailNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailAddr":{"type":"string","description":"Email Address"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrEmail":{"type":"string","description":"Email Address"},"mbrStatCd":{"type":"string","description":"Member Status"},"emailRecvAgrYn":{"type":"string","description":"Email Receipt Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationEmailCnt":{"type":"integer","format":"int32","description":"Email Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"dateSelect":{"type":"string","description":"Select Search Period"}}},"RealGridListResponseSendEmailMgmtResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/SendEmailMgmtResponse"}}}},"SendEmailMgmtResponse":{"type":"object","description":"Email Sending Response","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailSndMethCd":{"type":"string","description":"Send Method Code"},"emailSndMethCdNm":{"type":"string","description":"Send Method"},"emailSndStatCd":{"type":"string","description":"Send Status Code"},"emailSndStatCdNm":{"type":"string","description":"Send Status"},"emailTypCd":{"type":"string","description":"Email Type Code"},"emailTypCdNm":{"type":"string","description":"Email Type"},"emailTrgmnTypCd":{"type":"string","description":"Target Type Code"},"emailTrgmnTypCdNm":{"type":"string","description":"Target Type"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"sndCnt":{"type":"integer","format":"int32","description":"Target Count"},"notSentCnt":{"type":"integer","format":"int32","description":"Unsent Count"},"sucsCnt":{"type":"integer","format":"int32","description":"Success Count"},"failCnt":{"type":"integer","format":"int32","description":"Failure Count"},"emailSndStrDtm":{"type":"string","format":"date-time","description":"Send Start Date/Time"},"emailSndEndDtm":{"type":"string","format":"date-time","description":"Send End Date/Time"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"emailAddr":{"type":"string","description":"Email Address"},"sendResult":{"type":"string","description":"Send Result"},"sendResultNm":{"type":"string","description":"Send Result Name"},"failCaus":{"type":"string","description":"Failure Reason"},"mbrEmailSndTrgCount":{"type":"integer","format":"int32","description":"Email Sending Target Count"},"siteNm":{"type":"string","description":"Site Name"}}},"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/sendEmailMgmt/getSendEmailTargetMemberList":{"get":{"tags":["Email Sending Management"],"summary":"Retrieve Email Recipient Information List","description":"  ## Function Description\n  * Retrieves the email recipient list.\n  ---\n  ## Detailed Description\n  * Retrieves the email recipient list.\n","operationId":"getSendEmailTargetMemberList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SendEmailMgmtRequest"}},{"name":"mbrNo","in":"query","description":"Member No.","schema":{"type":"String"}},{"name":"sndRes","in":"query","description":"Send Result","schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseSendEmailMgmtResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Email Sending Information List

> &#x20; \## Function Description\
> &#x20; \* Retrieves the email sending list.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Retrieves the email sending list.<br>

```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":{"SendEmailMgmtRequest":{"type":"object","description":"Email Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email Sending No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date-time","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date-time","description":"Search Period End Date"},"emailSndMethCd":{"type":"string","description":"Send Method (CM023)"},"searchCondition":{"type":"string","description":"Search Condition (Email Subject/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"emailSndStatCd":{"type":"string","description":"Send Status (CM022)"},"emailTypCd":{"type":"string","description":"Email Type (CM025)"},"emailTrgmnTypCd":{"type":"string","description":"Recipient Type (CM028)"},"siteNm":{"type":"string","description":"Site Name"},"sndRes":{"type":"string","description":"Send Result"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"emailNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailAddr":{"type":"string","description":"Email Address"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrEmail":{"type":"string","description":"Email Address"},"mbrStatCd":{"type":"string","description":"Member Status"},"emailRecvAgrYn":{"type":"string","description":"Email Receipt Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationEmailCnt":{"type":"integer","format":"int32","description":"Email Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"dateSelect":{"type":"string","description":"Select Search Period"}}},"RealGridListResponseSendEmailMgmtResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/SendEmailMgmtResponse"}}}},"SendEmailMgmtResponse":{"type":"object","description":"Email Sending Response","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailSndMethCd":{"type":"string","description":"Send Method Code"},"emailSndMethCdNm":{"type":"string","description":"Send Method"},"emailSndStatCd":{"type":"string","description":"Send Status Code"},"emailSndStatCdNm":{"type":"string","description":"Send Status"},"emailTypCd":{"type":"string","description":"Email Type Code"},"emailTypCdNm":{"type":"string","description":"Email Type"},"emailTrgmnTypCd":{"type":"string","description":"Target Type Code"},"emailTrgmnTypCdNm":{"type":"string","description":"Target Type"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"sndCnt":{"type":"integer","format":"int32","description":"Target Count"},"notSentCnt":{"type":"integer","format":"int32","description":"Unsent Count"},"sucsCnt":{"type":"integer","format":"int32","description":"Success Count"},"failCnt":{"type":"integer","format":"int32","description":"Failure Count"},"emailSndStrDtm":{"type":"string","format":"date-time","description":"Send Start Date/Time"},"emailSndEndDtm":{"type":"string","format":"date-time","description":"Send End Date/Time"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"emailAddr":{"type":"string","description":"Email Address"},"sendResult":{"type":"string","description":"Send Result"},"sendResultNm":{"type":"string","description":"Send Result Name"},"failCaus":{"type":"string","description":"Failure Reason"},"mbrEmailSndTrgCount":{"type":"integer","format":"int32","description":"Email Sending Target Count"},"siteNm":{"type":"string","description":"Site Name"}}},"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/sendEmailMgmt/getSendEmailList":{"get":{"tags":["Email Sending Management"],"summary":"Retrieve Email Sending Information List","description":"  ## Function Description\n  * Retrieves the email sending list.\n  ---\n  ## Detailed Description\n  * Retrieves the email sending list.\n","operationId":"getSendEmailList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SendEmailMgmtRequest"}},{"name":"searchPeriod","in":"query","description":"Search Period Type","schema":{"type":"String"}},{"name":"sndStrDtm","in":"query","description":"Search Period Start Date","schema":{"type":"LocalDate"}},{"name":"sndEndDtm","in":"query","description":"Search Period End Date","schema":{"type":"LocalDate"}},{"name":"msgSndMethCd","in":"query","description":"Send Method (CM023)","schema":{"type":"String"}},{"name":"searchCondition","in":"query","description":"Search Condition (Email Subject/No.)","schema":{"type":"String"}},{"name":"searchConditionContents","in":"query","description":"Search Condition Details","schema":{"type":"String"}},{"name":"msgSndStatCd","in":"query","description":"Send Status (CM022)","schema":{"type":"String"}},{"name":"msgTypCd","in":"query","description":"Email Type (CM025)","schema":{"type":"String"}},{"name":"msgSndTypCd","in":"query","description":"Recipient Type (CM028)","schema":{"type":"String"}},{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseSendEmailMgmtResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Email Basic Information

> &#x20; \## Function Description\
> &#x20; \* Retrieves the email basic information.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Retrieves the email basic information.<br>

```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":{"SendEmailMgmtRequest":{"type":"object","description":"Email Sending Request","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email Sending No."},"searchPeriod":{"type":"string","description":"Search Period Type"},"sndStrDtm":{"type":"string","format":"date-time","description":"Search Period Start Date"},"sndEndDtm":{"type":"string","format":"date-time","description":"Search Period End Date"},"emailSndMethCd":{"type":"string","description":"Send Method (CM023)"},"searchCondition":{"type":"string","description":"Search Condition (Email Subject/No.)"},"searchConditionContents":{"type":"string","description":"Search Condition Details"},"emailSndStatCd":{"type":"string","description":"Send Status (CM022)"},"emailTypCd":{"type":"string","description":"Email Type (CM025)"},"emailTrgmnTypCd":{"type":"string","description":"Recipient Type (CM028)"},"siteNm":{"type":"string","description":"Site Name"},"sndRes":{"type":"string","description":"Send Result"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"emailNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailAddr":{"type":"string","description":"Email Address"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrMgrNm":{"type":"string","description":"Member Management Code Name"},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"mbrEmail":{"type":"string","description":"Email Address"},"mbrStatCd":{"type":"string","description":"Member Status"},"emailRecvAgrYn":{"type":"string","description":"Email Receipt Consent"},"applyYn":{"type":"string","description":"Application Status"},"errorCode":{"type":"string","description":"Error Code"},"errorMsg":{"type":"string","description":"Error Message"},"duplicationEmailCnt":{"type":"integer","format":"int32","description":"Email Duplicate Count"},"validationType":{"type":"string","description":"Validation Type"},"loginId":{"type":"string","description":"Login ID"},"tgtMbrNo":{"type":"string","description":"Duplicate Target Member No."},"dateSelect":{"type":"string","description":"Select Search Period"}}},"SendEmailMgmtResponse":{"type":"object","description":"Email Sending Response","properties":{"siteNo":{"type":"string","description":"Site No."},"emailSndNo":{"type":"string","description":"Email No."},"emailTitle":{"type":"string","description":"Email Subject"},"emailConts":{"type":"string","description":"Email Content"},"emailSndMethCd":{"type":"string","description":"Send Method Code"},"emailSndMethCdNm":{"type":"string","description":"Send Method"},"emailSndStatCd":{"type":"string","description":"Send Status Code"},"emailSndStatCdNm":{"type":"string","description":"Send Status"},"emailTypCd":{"type":"string","description":"Email Type Code"},"emailTypCdNm":{"type":"string","description":"Email Type"},"emailTrgmnTypCd":{"type":"string","description":"Target Type Code"},"emailTrgmnTypCdNm":{"type":"string","description":"Target Type"},"emailSndRsvDtm":{"type":"string","format":"date-time","description":"Scheduled Send Date/Time"},"sndCnt":{"type":"integer","format":"int32","description":"Target Count"},"notSentCnt":{"type":"integer","format":"int32","description":"Unsent Count"},"sucsCnt":{"type":"integer","format":"int32","description":"Success Count"},"failCnt":{"type":"integer","format":"int32","description":"Failure Count"},"emailSndStrDtm":{"type":"string","format":"date-time","description":"Send Start Date/Time"},"emailSndEndDtm":{"type":"string","format":"date-time","description":"Send End Date/Time"},"emailSndSeq":{"type":"string","description":"Email Send Sequence No."},"mbrNo":{"type":"string","description":"Member No."},"mbrId":{"type":"string","description":"Member ID"},"mbrNm":{"type":"string","description":"Member Name"},"mbrGradeNm":{"type":"string","description":"Member Grade Name"},"emailAddr":{"type":"string","description":"Email Address"},"sendResult":{"type":"string","description":"Send Result"},"sendResultNm":{"type":"string","description":"Send Result Name"},"failCaus":{"type":"string","description":"Failure Reason"},"mbrEmailSndTrgCount":{"type":"integer","format":"int32","description":"Email Sending Target Count"},"siteNm":{"type":"string","description":"Site Name"}}},"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/sendEmailMgmt/getSendEmailBaseInfo":{"get":{"tags":["Email Sending Management"],"summary":"Retrieve Email Basic Information","description":"  ## Function Description\n  * Retrieves the email basic information.\n  ---\n  ## Detailed Description\n  * Retrieves the email basic information.\n","operationId":"getSendEmailBaseInfo","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SendEmailMgmtRequest"}},{"name":"emailSndNo","in":"query","description":"Email No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SendEmailMgmtResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Issue New Email No.

> &#x20; \## Function Description\
> &#x20; \* Issues a new email number.\
> &#x20; \---\
> &#x20; \## Detailed Description\
> &#x20; \* Issues a new email number.<br>

```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":{"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/sendEmailMgmt/getNextEmailSndNo":{"get":{"tags":["Email Sending Management"],"summary":"Issue New Email No.","description":"  ## Function Description\n  * Issues a new email number.\n  ---\n  ## Detailed Description\n  * Issues a new email number.\n","operationId":"getNextEmailSndNo","responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```