API documentation

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

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