> 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/marketing-bo-api/event-template-management.md).

# Event Template Management

## Retrieve Registered Event Template List

> \## Function Description\
> \* Retrieves the list of registered event templates.\
> \---\
> \## Detailed Description\
> \* There are no required values.\
> \* \*\*Usage Status (tmplUseYn), Template No./Name (tmplNo), Template Description (tmplDtlCont)\*\*\
> \* Retrieves data matching the conditions using the above parameters.<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":{"CcEvtTmplBaseRequest":{"type":"object","properties":{"tmplNo":{"type":"string","description":"Template No."},"tmplNm":{"type":"string","description":"Template Name"},"tmplUseYn":{"type":"string","description":"Template Usage Status"},"tmplDtlCont":{"type":"string","description":"Template Detail Content"}}},"RealGridListResponseCcEvtTmplBaseResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/CcEvtTmplBaseResponse"}}}},"CcEvtTmplBaseResponse":{"type":"object","properties":{"tmplNo":{"type":"string","description":"Template No."},"tmplNm":{"type":"string","description":"Template Name"},"tmplUseYn":{"type":"string","description":"Template Usage Status"},"tmplDtlCont":{"type":"string","description":"Template Detail Content"},"tmplDtlInfoList":{"type":"array","description":"Template Detail Information LIST","items":{"$ref":"#/components/schemas/CcEvtTmplDtlInfoResponse"}}}},"CcEvtTmplDtlInfoResponse":{"type":"object","properties":{"tmplNo":{"type":"string","description":"Template No."},"tmplDtlGbCd":{"type":"string","description":"Template Detail Classification Code (EV014)","enum":["FREE_COMPOSITION","NOTICE_BOARD","FAQ"]},"tmplDtlSeq":{"type":"string","description":"Template Detail Sequence No."},"tmplDtlCmpsCd":{"type":"string","description":"Template Detail Configuration Code (EV016)","enum":["HTML","ONE_LINE","ATTENDANCE","FAQ","POST","POST_COMMENT","POST_IMAGE","POST_COMMENT_IMAGE"]},"tmplPrioRnk":{"type":"string","description":"Template Priority"},"htmlFileCont":{"type":"string","description":"HTML File Content"},"pcHtmlFileCont":{"type":"string","description":"HTML File Content (PC)"}}},"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/marketing/eventTemplateMgmt/getTemplateList":{"post":{"tags":["Event Template Management"],"summary":"Retrieve Registered Event Template List","description":"## Function Description\n* Retrieves the list of registered event templates.\n---\n## Detailed Description\n* There are no required values.\n* **Usage Status (tmplUseYn), Template No./Name (tmplNo), Template Description (tmplDtlCont)**\n* Retrieves data matching the conditions using the above parameters.\n","operationId":"getTemplateList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CcEvtTmplBaseRequest"}}},"required":true},"responses":{"200":{"description":"Template List Inquiry Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCcEvtTmplBaseResponse"}}}},"900":{"description":"Template List Inquiry Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Save Event Template Grid

> \## Function Description\
> \* Saves the event template grid.\
> \---\
> \## Detailed Description\
> \* \*\*Template No. (tmplNo)\*\* is required.\
> \* Saves rows checked for row deletion (row deletion feature).<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":{"RealGridCUDRequestCcEvtTmplBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/CcEvtTmplBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/CcEvtTmplBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/CcEvtTmplBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/CcEvtTmplBase"}}}},"CcEvtTmplBase":{"type":"object","properties":{"tmplNo":{"type":"string","description":"Template No."},"tmplNm":{"type":"string","description":"Template Name"},"tmplUseYn":{"type":"string","description":"Template Usage Status"},"tmplDtlCont":{"type":"string","description":"Template Detail Content"},"updateFlag":{"type":"string","description":"Column Used on Modification"}}},"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/marketing/eventTemplateMgmt/saveEventTemplateGrid":{"post":{"tags":["Event Template Management"],"summary":"Save Event Template Grid","description":"## Function Description\n* Saves the event template grid.\n---\n## Detailed Description\n* **Template No. (tmplNo)** is required.\n* Saves rows checked for row deletion (row deletion feature).\n","operationId":"saveEventTemplateGrid","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestCcEvtTmplBase"}}},"required":true},"responses":{"200":{"description":"Template Grid Save Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Template Grid Save Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Register Event Template Detail

> \## Function Description\
> \* Registers the event template detail.\
> \---\
> \## Detailed Content\
> \* \*\*Template No. (tmplNo), Template Detail Type Code (EV014) (tmplDtlGbCd), Template Detail Sequence No. (tmplDtlSeq), Template Detail Composition Code (EV016) (tmplDtlCmpsCd), Template Priority (tmplPrioRnk)\*\* are required.\
> \* Modifies an existing template or registers a new template base.<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":{"CcEvtTmplDtlInfo":{"type":"object","properties":{"tmplNo":{"type":"string","description":"Template No."},"tmplDtlGbCd":{"type":"string","description":"Template Detail Classification Code (EV014)","enum":["FREE_COMPOSITION","NOTICE_BOARD","FAQ"]},"tmplDtlSeq":{"type":"string","description":"Template Detail Sequence No."},"tmplDtlCmpsCd":{"type":"string","description":"Template Detail Configuration Code (EV016 11: HTML Editor, 21: One-line Comment, 22: Attendance Check, 23: FAQ, 24: Post, 25: Post+Comment, 26: Post+Image, 27: Post+Comment+Image)"},"tmplPrioRnk":{"type":"integer","format":"int32","description":"Template Priority"},"htmlFileCont":{"type":"string","description":"HTML File Content"},"pcHtmlFileCont":{"type":"string","description":"HTML File Content (PC)"}}},"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/marketing/eventTemplateMgmt/saveEventTemplateDtlInfo":{"post":{"tags":["Event Template Management"],"summary":"Register Event Template Detail","description":"## Function Description\n* Registers the event template detail.\n---\n## Detailed Content\n* **Template No. (tmplNo), Template Detail Type Code (EV014) (tmplDtlGbCd), Template Detail Sequence No. (tmplDtlSeq), Template Detail Composition Code (EV016) (tmplDtlCmpsCd), Template Priority (tmplPrioRnk)** are required.\n* Modifies an existing template or registers a new template base.\n","operationId":"saveEventTemplateDtlInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CcEvtTmplDtlInfo"}}},"required":true},"responses":{"200":{"description":"Template Detail Registration Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Template Detail Registration Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Register Event Template Base

> \## Function Description\
> \* Registers the event template base.\
> \---\
> \## Detailed Description\
> \* \*\*Template No. (tmplNo), Template Name (tmplNm), Usage Status (tmplUseYn), Detail Content (tmplDtlCont)\*\* are required.\
> \* Modifies an existing template or registers a new template base.<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":{"CcEvtTmplBase":{"type":"object","properties":{"tmplNo":{"type":"string","description":"Template No."},"tmplNm":{"type":"string","description":"Template Name"},"tmplUseYn":{"type":"string","description":"Template Usage Status"},"tmplDtlCont":{"type":"string","description":"Template Detail Content"},"updateFlag":{"type":"string","description":"Column Used on Modification"}}},"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/marketing/eventTemplateMgmt/saveEventTemplateBase":{"post":{"tags":["Event Template Management"],"summary":"Register Event Template Base","description":"## Function Description\n* Registers the event template base.\n---\n## Detailed Description\n* **Template No. (tmplNo), Template Name (tmplNm), Usage Status (tmplUseYn), Detail Content (tmplDtlCont)** are required.\n* Modifies an existing template or registers a new template base.\n","operationId":"saveEventTemplateBase","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CcEvtTmplBase"}}},"required":true},"responses":{"200":{"description":"Template Base Registration Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Template Base Registration Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Generate Event Template Sequence Number

> \## Function Description\
> \* Generates a sequence number for the event template.\
> \---\
> \## Detailed Description\
> \* No required values.<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/marketing/eventTemplateMgmt/getTmplNo":{"get":{"tags":["Event Template Management"],"summary":"Generate Event Template Sequence Number","description":"## Function Description\n* Generates a sequence number for the event template.\n---\n## Detailed Description\n* No required values.\n","operationId":"getTmplNo","responses":{"200":{"description":"Template Sequence Number Generation Success","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}},"900":{"description":"Template Sequence Number Generation Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Event Template for Modification

> \## Function Description\
> \* Retrieves the event template for modification.\
> \---\
> \## Detailed Description\
> \* \*\*Template No. (tmplNo)\*\* is required.<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":{"CcEvtTmplBaseResponse":{"type":"object","properties":{"tmplNo":{"type":"string","description":"Template No."},"tmplNm":{"type":"string","description":"Template Name"},"tmplUseYn":{"type":"string","description":"Template Usage Status"},"tmplDtlCont":{"type":"string","description":"Template Detail Content"},"tmplDtlInfoList":{"type":"array","description":"Template Detail Information LIST","items":{"$ref":"#/components/schemas/CcEvtTmplDtlInfoResponse"}}}},"CcEvtTmplDtlInfoResponse":{"type":"object","properties":{"tmplNo":{"type":"string","description":"Template No."},"tmplDtlGbCd":{"type":"string","description":"Template Detail Classification Code (EV014)","enum":["FREE_COMPOSITION","NOTICE_BOARD","FAQ"]},"tmplDtlSeq":{"type":"string","description":"Template Detail Sequence No."},"tmplDtlCmpsCd":{"type":"string","description":"Template Detail Configuration Code (EV016)","enum":["HTML","ONE_LINE","ATTENDANCE","FAQ","POST","POST_COMMENT","POST_IMAGE","POST_COMMENT_IMAGE"]},"tmplPrioRnk":{"type":"string","description":"Template Priority"},"htmlFileCont":{"type":"string","description":"HTML File Content"},"pcHtmlFileCont":{"type":"string","description":"HTML File Content (PC)"}}},"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/marketing/eventTemplateMgmt/getTmplInfo":{"get":{"tags":["Event Template Management"],"summary":"Retrieve Event Template for Modification","description":"## Function Description\n* Retrieves the event template for modification.\n---\n## Detailed Description\n* **Template No. (tmplNo)** is required.\n","operationId":"getTmplInfo","parameters":[{"name":"tmplNo","in":"query","description":"Template No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Template Retrieval for Modification Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CcEvtTmplBaseResponse"}}}},"900":{"description":"Template Retrieval for Modification Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Delete Detail Data When Modifying Event Template

> \## Function Description\
> \* Deletes detail data when modifying the event template.\
> \---\
> \## Detailed Description\
> \* \*\*Template No. (tmplNo)\*\* is required.<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/marketing/eventTemplateMgmt/deleteEventTemplateDtlInfo":{"get":{"tags":["Event Template Management"],"summary":"Delete Detail Data When Modifying Event Template","description":"## Function Description\n* Deletes detail data when modifying the event template.\n---\n## Detailed Description\n* **Template No. (tmplNo)** is required.\n","operationId":"deleteEventTemplateDtlInfo","parameters":[{"name":"tmplNo","in":"query","description":"Template No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Detail Data Deletion Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Detail Data Deletion Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
