API documentation

POST /agent_messages

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/agent_messages

Create Agent Message.

Sends a message that is broadcast asynchronously to the live agent widgets of the buyers, buyer groups, and call centers listed in buyer_ids, buyer_group_ids, and call_center_ids. If agent_status_id is set, it also updates the status shown for each matching agent. Requires administrator or manager level API access.

Params

Param name	Description
content Required	Content Must be a String
agent_status_id Optional Blank value allowed	Agent Status Must be a valid foreign key reference to an Agent Status. Refer to: /api/docs/1.0/agent_statuses
buyer_ids Optional Blank value allowed	Agents Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
buyer_group_ids Optional Blank value allowed	Buyer Groups Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Buyer Group. Refer to: /api/docs/1.0/buyer_groups
call_center_ids Optional Blank value allowed	Call Centers Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Call Center. Refer to: /api/docs/1.0/call_centers

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/agent_messages/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "content": "This is an example broadcast message to agents."
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "agent_message": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "AgentMessage",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": "/agent_messages/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "content": "This is an example broadcast message to agents.",
    "agent_status_id": null,
    "user_id": 10002,
    "agent_widget_count": 1
  },
  "metadata": {
    "root": "agent_message"
  }
}