Skip to main content
POST
/
api
/
v1
/
sms
/
send
Send an SMS message
curl --request POST \
  --url https://{subdomain}.mindhunters.ai/api/v1/sms/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agentId": "32d8fc98-be1e-4d32-a12e-146f397fb1cb",
  "phoneNumber": "+12345678900",
  "message": "Hello! Your appointment is confirmed for tomorrow at 10:00 AM."
}
'
{
  "success": true,
  "message": "SMS message sent successfully",
  "data": {
    "messageId": "4010122d-3cf7-4670-b74c-2f5e2f3e79c0",
    "recipientPhone": "+12345678900",
    "conversationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Body

application/json
​
agentId
string<uuid>
required

UUID of the Agent. Must exist and have SMS channel configured.

Example:

"32d8fc98-be1e-4d32-a12e-146f397fb1cb"

​
phoneNumber
string
required

Phone number of the recipient in E.164 format (e.g., +1234567890).

Example:

"+12345678900"

​
message
string
required

SMS message body. Must be between 1 and 1600 characters.

Required string length: 1 - 1600
Example:

"Hello! Your appointment is confirmed for tomorrow at 10:00 AM."

Response

Success

​
success
boolean
Example:

true

​
message
string
Example:

"SMS message sent successfully"

​
data
object