Skip to main content
POST
/
api
/
v2
/
agent
/
outboundSms
curl --request POST \
  --url 'https://api.vida.dev/api/v2/agent/outboundSms?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": "+15551234567",
  "content": "Hi, quick reminder for tomorrow at 10am.",
  "context": "Reminder campaign"
}
'
{
  "success": true,
  "message": "Outbound SMS initiated.",
  "inserted": 3,
  "tasks": [
    {}
  ]
}

Authorizations

​
token
string
query
required

Vida API Token

Body

application/json
  • Option 1
  • Option 2
​
target
string
required

Phone in E.164 or VIDA username

Example:

"+1234567890"

​
content
string
required

Message body

Example:

"Hello from Acme. Your appointment is tomorrow at 10am."

​
context
string

Optional context for the agent handling the conversation

​
taskContext
string

Task-specific context for this message

​
agentId
integer

Optional campaign id override

​
scheduledFor
integer

Unix seconds to schedule delivery

​
meta
object

Optional metadata

​
externalTaskId
string

Optional customer-provided identifier applied to created task(s)

Response

Queued successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Outbound SMS initiated."

​
inserted
integer
Example:

3

​
tasks
object[]