API documentation

GET /agent_messages

Authorization Required

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

List Agent Message records.

Returns a paginated list of Agent Message records for the account, newest first by default. Requires administrator or manager level API access. Supports the standard id and created_at range filters.

Params

Param name	Description
ids Optional	Return records matching these ids. Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Must be a number.
per_page Optional	How many results to return per page. The default is 25. Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
fulltext Optional	Search for any record that matches this text Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id company_id content agent_status_id user_id agent_widget_count Must be a String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/agent_messages/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "agent_messages": [
    {
      "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": "Reminder: new buyer caps go live at 5pm today.",
      "agent_status_id": null,
      "user_id": 10002,
      "agent_widget_count": 1
    }
  ],
  "metadata": {
    "root": "agent_messages",
    "page": 1,
    "total_pages": 1,
    "per_page": 2,
    "total_count": 1,
    "next_cursor": 10003
  }
}

GET /agent_messages/new

Authorization Required

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

Build Agent Message with defaults.

Builds an unsaved Agent Message populated with default attribute values so you can preview what a new record looks like before calling create. Nothing is written to the database.

Params

Param name

Description

content
Optional Blank value allowed

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

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/agent_messages/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "agent_message": {
    "id": null,
    "type": "AgentMessage",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": null,
    "routes_edit_path": null,
    "external_record_id": null,
    "company_id": 10001,
    "content": null,
    "agent_status_id": null,
    "user_id": null,
    "agent_widget_count": 0
  },
  "metadata": {
    "root": "agent_message"
  }
}

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"
  }
}

GET /agent_messages/:id

Authorization Required

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

Get Agent Message by id.

Retrieves a single Agent Message by id, scoped to your company.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/agent_messages/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "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"
  }
}

PUT /agent_messages/:id

Authorization Required

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

Update Agent Message by id.

Updates the content or agent_status_id of an existing Agent Message. Saving the change re-triggers the asynchronous broadcast to the same agent widgets that were targeted at creation; the buyer, buyer group, and call center targeting itself cannot be changed after the message is created.

Params

Param name	Description
content Optional Blank value allowed	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 PUT 'https://[your-subdomain].trackdrive.com/api/v1/agent_messages/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "content": "This is an updated example broadcast message."
}'

Example Response 200

{
  "status": 200,
  "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 updated example broadcast message.",
    "agent_status_id": null,
    "user_id": 10002,
    "agent_widget_count": 1
  },
  "metadata": {
    "root": "agent_message"
  }
}

DELETE /agent_messages/:id

Authorization Required

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

Destroy Agent Message by id.

Soft-deletes an Agent Message by id. The record is retained but excluded from future index and show results, and the agents' screens it was sent to update immediately to reflect the removal.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/agent_messages/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "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": "2026-01-15T15:30:00.000Z",
    "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": 0
  },
  "metadata": {
    "root": "agent_message"
  }
}

Params

Must be any combination of:

Params

Params

Params