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.
Authorizations
Vida API Token
Headers
Required for submissions over 1,000 targets. Repeating the same key and payload safely resumes or returns that submission.
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
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 metadata
Reusable customer correlation/grouping ID; not an idempotency key
Optional Contact List to enroll the contact into