POST
/
api
/
v2
/
agent
/
outboundSms
curl --request POST \
  --url https://api.vida.dev/api/v2/agent/outboundSms \
  --header 'Content-Type: application/json' \
  --data '{
  "context": "Name: Lyle Pratt. Interest: Completed a call back form on our website for more information about our products.",
  "target": "+1234567890 or john_doe",
  "content": "Hello this is Alice reaching out from Acme Inc with an appointment reminder. You have a scheduled appointment for tomorrow at 10AM."
}'
{
  "success": true,
  "message": "Outbound sms initiated."
}

Authorizations

token
string
query
required

Vida API Token

Body

application/json
target
string
required

Phone number in E.164 format or VIDA username of the user

content
string
required

The content of the outbound message.

context
string

Additional context you want your Agent to be aware of when handling the conversation.

Response

200 - application/json
Success
success
boolean
message
string