{
"success": true,
"message": "Outbound SMS initiated.",
"inserted": 3,
"batchId": "f52b1e01-5cbc-483c-9939-3bf7d37e1426",
"tasks": [
{}
]
}Queue outbound SMS text message(s) from your Agent
Queue SMS Tasks for one target and message or up to 10,000 targets. The endpoint accepts Task goals, retry policies, organization defaults, external correlation IDs, metadata, and Contact List enrollment. Submissions over 1,000 targets require Idempotency-Key and return 202. Use meta.contact for structured Contact data such as name, email, address and customFields. In a batch, put lead-specific metadata on each target object. See Contact fields for the complete metadata field reference.
{
"success": true,
"message": "Outbound SMS initiated.",
"inserted": 3,
"batchId": "f52b1e01-5cbc-483c-9939-3bf7d37e1426",
"tasks": [
{}
]
}Authorizations
Vida API Token
Headers
Required for submissions over 1,000 targets. Repeating the same key and payload safely resumes or returns that submission.
Show child attributes
Show child attributes
Body
- Option 1
- Option 2
Phone in E.164 or VIDA username
"+1234567890"
Message body
"Hello from Acme. Your appointment is tomorrow at 10am."
Optional context for the agent handling the conversation
Task-specific context for this message
Optional agent account id override for the message
Attached agent phone number with active messaging for this Task and its call/text retries. Omit, null or blank uses automatic routing. Overrides Contact pins for this Task only. Quota or unavailable lines delay the Task without switching numbers.
Optional campaign id override
Unix seconds to schedule delivery
Task-specific goal with completionCriteria. Omit or pass null to use the organization default.
Task-specific cadence using delaysSeconds or mixed-channel steps, retryOn, and optional responseTimeoutSeconds. Omit or pass null to use the organization default.
Optional Task metadata. meta.contact fills missing structured Contact fields at creation; existing values are preserved. For multiple targets, set contact data in meta.contact on each target object. Per-item meta replaces the entire top-level meta object; it is not deep-merged.
Show child attributes
Show child attributes
Reusable customer correlation/grouping ID; not an idempotency key
Optional Contact List to enroll the contact into