POST /v1/messages/send
Service: comms · operationId: (none)
Required scopes
(no scope declared — review service config)
Request body
{
"type": "object",
"properties": {
"channel": {
"type": "string",
"enum": [
"email",
"sms",
"push",
"in_app"
]
},
"template_key": {
"type": "string",
"minLength": 1
},
"recipient": {
"type": "string",
"minLength": 1
},
"brand_id": {
"type": "string",
"minLength": 1
},
"person_id": {
"type": "string",
"minLength": 1
},
"variables": {
"type": "object",
"additionalProperties": {},
"default": {}
},
"dedup_key": {
"type": "string",
"minLength": 1
},
"hipaa": {
"type": "boolean",
"default": false
}
},
"required": [
"channel",
"template_key",
"recipient",
"brand_id",
"person_id",
"dedup_key"
]
}Responses
200 Message sent successfully
{
"type": "object",
"properties": {
"message_id": {
"type": "string"
},
"dedup_key": {
"type": "string"
},
"channel": {
"type": "string"
},
"status": {
"type": "string"
},
"provider": {
"type": [
"string",
"null"
]
}
},
"required": [
"message_id",
"dedup_key",
"channel",
"status",
"provider"
]
}409 Duplicate message (dedup key already used)
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}422 Precondition failed (suppressed, no consent)
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}Example
curl -X POST https://comms.platform.loop.health/v1/messages/send \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'Related
services/comms— service overview- All endpoints — directory across services
- Auth model — how scopes are enforced