Messaging Templates

Resolve template

post

The request allows to resolve the selected message template. The response will include the entire text of the message, as well as the data that is substituted into the variables inside this template.

resolverServiceType - possible values: EMAIL, CHAT, SMS, WHATSAPP

templateName - name of the message template, which can be viewed in the Designer

Authorizations

AuthorizationstringRequired

Bearer token obtained from POST /{tenantName}/admin/api_clients/{clientName}. Valid for 60 minutes.

Path parameters

tenantNamestringRequired

Your organization (tenant) name, e.g. acme-health

Example: acme-health

instanceNamestringRequired

Your environment name: live, sandbox, or a custom name

Example: live

patientIdstring · uuidRequired

UUID of the patient record

resolverServiceTypestringRequired

resolverServiceType path parameter

templateNamestringRequired

templateName path parameter

Responses

200

Resolved template content

application/json

resolvedTextstring · nullableOptional

resolvedEmailEditorJsonstring · nullableOptional

textTypestring · enumOptionalPossible values:

subjectstring · nullableOptional

201

Success

400

Bad request — the request could not be understood or was missing required parameters.

401

Unauthorized — the Bearer token is missing, expired, or invalid.

403

Forbidden — the API client role does not have permission for this resource. Check the role and security policy in Admin.

404

Not found — the requested resource does not exist.

429

Too many requests — rate limit exceeded. Implement exponential backoff.

500

Internal server error.

post/{tenantName}/{instanceName}/patients/{patientId}/{resolverServiceType}/message-templates/resolve/{templateName}

POST /{tenantName}/{instanceName}/patients/{patientId}/{resolverServiceType}/message-templates/resolve/{templateName} HTTP/1.1
Host: api.live.welkincloud.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "resolvedText": "text",
  "resolvedEmailEditorJson": "text",
  "textType": "PLAIN_TEXT",
  "subject": "text",
  "dataContentVariables": [
    {
      "contentType": "TEXT",
      "variableName": "text",
      "textData": "text",
      "columns": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "structureData": [
        {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      ],
      "separatorType": "DASH",
      "borderType": "SOLID",
      "image": "text",
      "fileType": 1,
      "fileName": "text",
      "width": 1,
      "height": 1
    }
  ]
}