Message users
Send an Absorb message to selected users.
POST https://cotlet.dev/api/v1/absorb-lms/users/message
write Confirm
Sends a message from the Message User workspace of the Users, Course Activity and Course Approvals reports to the users you name. Absorb delivers it to the learners. Write the subject and body plainly; the tool sends what you give it. By default you confirm each call; you can switch that off for this tool.
Parameters
| Name | Type | Description |
|---|---|---|
| user_ids array required | array | user_id values from list_users or list_course_activity. |
| subject string required | string | Message subject. |
| body string required | string | Message text. |
Request
curl -X POST https://cotlet.dev/api/v1/absorb-lms/users/message \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"user_ids":["9b7e5d10-2c44-4f0b-8a31-6e2f9c4d7702","4f1c2a7e-8b3d-4c1a-9e55-0a6d3b7c1201"],"subject":"Warehouse Safety Basics is overdue","body":"Your Warehouse Safety Basics course was due on 19 Oct. Please finish it this week."}'result = client.call("absorb-lms", "message_users", {"user_ids":["9b7e5d10-2c44-4f0b-8a31-6e2f9c4d7702","4f1c2a7e-8b3d-4c1a-9e55-0a6d3b7c1201"],"subject":"Warehouse Safety Basics is overdue","body":"Your Warehouse Safety Basics course was due on 19 Oct. Please finish it this week."})const result = await cotlet.call('absorb-lms', 'message_users', {"user_ids":["9b7e5d10-2c44-4f0b-8a31-6e2f9c4d7702","4f1c2a7e-8b3d-4c1a-9e55-0a6d3b7c1201"],"subject":"Warehouse Safety Basics is overdue","body":"Your Warehouse Safety Basics course was due on 19 Oct. Please finish it this week."});cotlet call absorb-lms message_users --data '{"user_ids":["9b7e5d10-2c44-4f0b-8a31-6e2f9c4d7702","4f1c2a7e-8b3d-4c1a-9e55-0a6d3b7c1201"],"subject":"Warehouse Safety Basics is overdue","body":"Your Warehouse Safety Basics course was due on 19 Oct. Please finish it this week."}'Example response
{
"sent_to": [
{
"user_id": "9b7e5d10-2c44-4f0b-8a31-6e2f9c4d7702",
"name": "Omar Haddad"
},
{
"user_id": "4f1c2a7e-8b3d-4c1a-9e55-0a6d3b7c1201",
"name": "Dana Reyes"
}
],
"subject": "Warehouse Safety Basics is overdue"
}