POST /v1/account-export-link
Service: comms · operationId: (none)
Required scopes
(no scope declared — review service config)
Request body
{
"type": "object",
"properties": {
"brand_id": {
"type": "string",
"minLength": 1
},
"person_id": {
"type": "string",
"minLength": 1
},
"requester_email": {
"type": "string",
"format": "email"
},
"requester_name": {
"type": "string",
"minLength": 1
},
"download_url": {
"type": "string",
"format": "uri"
}
},
"required": [
"brand_id",
"person_id",
"requester_email",
"download_url"
]
}Responses
201 Account export link email sent
{
"type": "object",
"properties": {
"message_id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"requested",
"sent"
]
}
},
"required": [
"message_id",
"status"
]
}400 Validation or upstream error
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}403 Authenticated user does not match export owner
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"error",
"message"
]
}Example
curl -X POST https://comms.platform.loop.health/v1/account-export-link \
-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