Skip to main content
POST

Authorizations

token
string
query
required

Vida API Token

Body

application/json
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[]