POST api/v1/infrastructure/communicationtemplates

Use to create new template in system

Request Information

URI Parameters

None.

Body Parameters

all required template data

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.CommunicationTemplateVo
NameDescriptionTypeAdditional information
PracticeId

globally unique identifier

None.
TemplateId

globally unique identifier

None.
TemplateName

string

None.
TemplateType

string

None.
TemplateMediaType

string

None.
TemplateIdentifier

string

None.
TemplateBody

string

None.
Locale

string

None.
LastUpdated

date

None.
LastUpdatedBy

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "PracticeId": "85261c46-5fe3-485a-9f1b-22e373baf02f",
  "TemplateId": "ccc8db8d-8163-4c64-bd14-094ead005f9d",
  "TemplateName": "sample string 3",
  "TemplateType": "sample string 4",
  "TemplateMediaType": "sample string 5",
  "TemplateIdentifier": "sample string 6",
  "TemplateBody": "sample string 7",
  "Locale": "sample string 8",
  "LastUpdated": "2025-08-05T10:55:45Z",
  "LastUpdatedBy": "sample string 10"
}

application/xml, text/xml

Sample: 
<CommunicationTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/platform/commondomain/v1/communicationtemplate/">
  <LastUpdated>2025-08-05T10:55:45.7499424+02:00</LastUpdated>
  <LastUpdatedBy>sample string 10</LastUpdatedBy>
  <Locale>sample string 8</Locale>
  <PracticeId>85261c46-5fe3-485a-9f1b-22e373baf02f</PracticeId>
  <TemplateBody>sample string 7</TemplateBody>
  <TemplateId>ccc8db8d-8163-4c64-bd14-094ead005f9d</TemplateId>
  <TemplateIdentifier>sample string 6</TemplateIdentifier>
  <TemplateMediaType>sample string 5</TemplateMediaType>
  <TemplateName>sample string 3</TemplateName>
  <TemplateType>sample string 4</TemplateType>
</CommunicationTemplate>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'CommunicationTemplateVo'.

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Guid
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

globally unique identifier

None.
Links

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink

None.

Response Formats

application/json, text/json

Sample: 
{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": "88df226b-e7ed-48b5-b43b-da31ce38ec0b",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>88df226b-e7ed-48b5-b43b-da31ce38ec0b</Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfguid>