Docs
API ReferenceapimessagingPOST /v1/messaging/templates/{id}/render

POST /v1/messaging/templates/\{id\}/render

Service: messaging · operationId: (none)

Required scopes

(no scope declared — review service config)

Path parameters

  • id (string) required —

Request body

{
  "type": "object",
  "properties": {
    "payload": {
      "type": "object",
      "additionalProperties": {}
    },
    "strict": {
      "type": "boolean"
    },
    "version_id": {
      "type": "string"
    }
  },
  "required": [
    "payload"
  ]
}

Responses

200 Rendered

{
  "type": "object",
  "properties": {
    "subject": {
      "type": [
        "string",
        "null"
      ]
    },
    "body": {
      "type": "string"
    },
    "missing_variables": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "subject",
    "body",
    "missing_variables"
  ]
}

400 Validation

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "details": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "error",
    "message"
  ]
}

404 Not found

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "details": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "error",
    "message"
  ]
}

500 Server error

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "details": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X POST https://messaging.platform.loop.health/v1/messaging/templates/{id}/render \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Related

POST /v1/messaging/templatesPOST /v1/messaging/templates/{id}/versions