POST/transactional-api/create-communication-template

Create Communication Template

Creates a new communication template.

Authorization: Bearer token (JWT). See Authentication.

Request

curl -L -X POST 'https://{tenantId}.api.england.medicus.health/transactional-api/create-communication-template' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -d '{
    "name": "Appointment Reminder",
    "description": "Sent to patients 24 hours before their scheduled appointment."
  }'

Body parameters

Field	Type	Required	Description
name	string	Yes
description	string (nullable)	No

Responses

201 Created.

Response fields

Field	Type	Description
id	string<uuid>

{
  "id": "00000000-0000-0000-0000-000000000000"
}

400 Invalid request.

2 possible code values

Code	Description	When
missing-required-field	fieldName is required	a required field is absent
invalid-operation	Human-readable reason.	business rule violation

Response fields

Field	Type	Description
errors[].code	string
errors[].description	string

{
  "errors": [
    {
      "code": "missing-required-field",
      "description": "fieldName is required"
    }
  ]
}