API documentation

POST /text_messages

Authorization Required

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

Send a text message

Sends an outbound text message. If a matching lead is not already known, one is resolved or created from lead_id, schedule_id, or offer_id, and a sending number is chosen from number_id, from, or the resolved lead or schedule's SMS number. Pass manual true when a human is sending the message directly, which skips the DNC check on the destination. Restricted to account superusers and requires the text_messages permission.

Params

Param name	Description
from Optional Blank value allowed	Sending address (+E.164 formatted phone number.) Example: +18665550001 Must be a String
to Optional Blank value allowed	Receiving address (+E.164 formatted phone number.) Example: +18665550001 Must be a String
lead_id Optional Blank value allowed	Optional. Associate this text message with this lead. The lead’s telephone number will be used as the Receiving address if “to” is not provided. Must be a valid foreign key reference to an Lead. Refer to: /api/docs/1.0/leads
message Required	Message body (i.e., content) as non-empty string. Example: Hello! Must be a String
delivery_webhook_url Optional Blank value allowed	Webhook to call when the message’s status changes. Must be a String
manual Optional Blank value allowed	Pass true if this message is manually initiated by a human being in your application. When this is set to true Trackrive will skip checking if the “to” destination is on the DNC. Must be a boolean value: 1, true, yes, on, 0, false, no, off
number_id Optional Blank value allowed	Provide the sending address as an internal Trackdrive telephone number ID. Must be a valid foreign key reference to an Number. Refer to: /api/docs/1.0/phone_numbers
schedule_id Optional Blank value allowed	Optional. If a lead exists on this schedule, this text message will be associated with it. If no lead currently exists, one will be created, and it will be added to this schedule. Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
offer_id Optional Blank value allowed	Optional. Associate this text message with a matching lead on this offer. If no lead currently exists, one will be created on this offer. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/text_messages/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "number_id": 10001,
  "to": "+18005550123",
  "message": "Thanks for your submission! A representative will call in 60 seconds."
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "text_message": {
    "id": 10002,
    "type": "TextMessage",
    "uuid": null,
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/text_messages/10002",
    "routes_edit_path": "/text_messages/10002/edit",
    "external_record_id": null,
    "from": "+18445550150",
    "to": "+18005550123",
    "message": "Thanks for your submission! A representative will call in 60 seconds.",
    "name": "From +18445550150 To +18005550123",
    "number_id": 10001,
    "lead_id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "provider_configuration_id": 10003,
    "message_uuid": null,
    "destination_caller_id": "+18005550123",
    "status": "sent",
    "error_code": null,
    "ring_pool_id": null,
    "schedule_id": null,
    "sent_at": null,
    "manual": false,
    "contact_id": null,
    "delivery_webhook_url": null,
    "text_message_flow_id": null
  },
  "metadata": {
    "root": "text_message"
  }
}

GET /text_messages

Authorization Required

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

Retrieves details about text messages.

Returns outgoing text message records, including their delivery status. Restricted to account superusers and requires the text_messages permission.

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 from to message name number_id lead_id provider_configuration_id message_uuid destination_caller_id status error_code ring_pool_id schedule_id sent_at manual contact_id delivery_webhook_url text_message_flow_id 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/text_messages/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "text_messages": [
    {
      "id": 10001,
      "type": "TextMessage",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": null,
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/text_messages/10001",
      "routes_edit_path": "/text_messages/10001/edit",
      "external_record_id": null,
      "from": "+1900000005@sip1018927104081",
      "to": "+18005550123",
      "message": "Thanks for your submission! A representative will call in 60 seconds.",
      "name": "From +1900000005@sip1018927104081 To +18005550123",
      "number_id": 10002,
      "lead_id": null,
      "provider_configuration_id": 10003,
      "message_uuid": null,
      "destination_caller_id": "+18005550123",
      "status": "sent",
      "error_code": null,
      "ring_pool_id": null,
      "schedule_id": null,
      "sent_at": null,
      "manual": false,
      "contact_id": null,
      "delivery_webhook_url": null,
      "text_message_flow_id": null
    },
    {
      "id": 10004,
      "type": "TextMessage",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "created_at": "2026-01-15T14:30:00.000Z",
      "updated_at": null,
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/text_messages/10004",
      "routes_edit_path": "/text_messages/10004/edit",
      "external_record_id": null,
      "from": "+1900000005@sip1018927104081",
      "to": "+18005550123",
      "message": "Thanks for your submission! A representative will call in 60 seconds.",
      "name": "From +1900000005@sip1018927104081 To +18005550123",
      "number_id": 10002,
      "lead_id": null,
      "provider_configuration_id": 10003,
      "message_uuid": null,
      "destination_caller_id": "+18005550123",
      "status": "sent",
      "error_code": null,
      "ring_pool_id": null,
      "schedule_id": null,
      "sent_at": null,
      "manual": false,
      "contact_id": null,
      "delivery_webhook_url": null,
      "text_message_flow_id": null
    }
  ],
  "metadata": {
    "root": "text_messages",
    "page": 1,
    "total_pages": 20,
    "per_page": 2,
    "total_count": 40,
    "next_cursor": 10005
  }
}

GET /text_messages/:id

Authorization Required

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

Get a text message request

Returns a single outgoing text message by id, including its current delivery status. Restricted to account superusers and requires the text_messages permission.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "text_message": {
    "id": 10001,
    "type": "TextMessage",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/text_messages/10001",
    "routes_edit_path": "/text_messages/10001/edit",
    "external_record_id": null,
    "from": "+1900000005@sip1018927104081",
    "to": "+18005550123",
    "message": "Thanks for your submission! A representative will call in 60 seconds.",
    "name": "From +1900000005@sip1018927104081 To +18005550123",
    "number_id": 10002,
    "lead_id": null,
    "provider_configuration_id": 10003,
    "message_uuid": null,
    "destination_caller_id": "+18005550123",
    "status": "sent",
    "error_code": null,
    "ring_pool_id": null,
    "schedule_id": null,
    "sent_at": null,
    "manual": false,
    "contact_id": null,
    "delivery_webhook_url": null,
    "text_message_flow_id": null
  },
  "metadata": {
    "root": "text_message"
  }
}

Params

Params

Must be any combination of: