Create (and optionally send) a text message

Create a new text message record. Optionally send the SMS by setting send: true.

Default behavior (send: false or omitted):

  • Creates a record in the CRM without sending
  • Use this to log SMS messages sent through external systems

Sending SMS (send: true):

  • Uses team's default provider if smsProviderId is not specified
  • Optionally specify smsProviderId to use a specific provider
  • Actually sends the SMS through the specified/default provider
  • Provider must be configured and accessible to the API token

Auto-fill behavior:

  • If toNumber is blank/omitted, uses the person's primary phone number (or returns error if none exists)
  • If fromNumber is blank/omitted, uses the default SMS provider's phone number (or returns error if no provider configured)
  • This allows simplified message creation when using default contact information
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

Set to true to actually send the SMS (default: false)

uuid

SMS provider ID to use for sending (optional if send=true).
If not specified when send=true, uses team's default SMS provider.

Body Params
uuid
required

ID of the person this text message is for

uuid

User who sent the message (defaults to current user)

string
required
string

Recipient phone number. If blank, uses person's primary phone. Returns error if person has no primary phone.

string

Sender phone number. If blank, uses default SMS provider's phone number. Returns error if no default provider configured.

boolean

True if incoming message, false if outgoing

string | null

Label from external system

string | null

URL to message in external system

date-time | null

When the message was sent/received. Defaults to current time if not provided. Use this to preserve original timestamps when importing historical records.

Responses

401

unauthorized

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json