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.
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.
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.
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.