Queue outbound email(s) from your Agent

Queue email Tasks for an email-enabled agent account. Pass target or to/cc/bcc for one email, or use up to 10,000 targets for separate emails. Organization default goals and retries apply when configured; use POST /api/v2/tasks to supply a Task-specific goal or retry policy. Submissions over 1,000 targets require Idempotency-Key and return 202.

OpenAPI

````yaml post /api/v2/agent/outboundEmail
openapi: 3.0.0
info:
version: 2.0.0
title: GetVoiceBot API
description: GetVoiceBot API Documentation
servers:
- url: https://api.getvoicebot.com
description: GetVoiceBot Production
variables:
baseUrl:
default: api.getvoicebot.com
description: Production API Root
security: []
tags:
- name: Agents
- name: Inbound Email
description: Control which senders may create inbound email work for an Agent.
- name: Features
description: Inspect capabilities available within an account hierarchy.
- name: Conversation Logs
description: Query conversation activity and calculate account-level metrics.
- name: Computer Agents
description: Set up, configure, inspect, and manage GetVoiceBot Computer Agents.
- name: Computer Agent Sessions
description: View and reset Computer Agent sessions.
- name: Accounts
- name: Agent Templates
description: Create, manage, and apply reusable Agent configurations.
paths:
/api/v2/agent/outboundEmail:
post:
tags:
- Agents
summary: Queue outbound email(s) from your Agent
description: >-
Queue email Tasks for an email-enabled agent account. Pass target or
to/cc/bcc for one email, or use up to 10,000 targets for separate
emails. Organization default goals and retries apply when configured;
use POST /api/v2/tasks to supply a Task-specific goal or retry policy.
Submissions over 1,000 targets require Idempotency-Key and return 202.
parameters:
- name: Idempotency-Key
in: header
required: false
schema:
type: object
properties:
type:
type: string
example: string
maxLength:
type: number
example: 200
description: >-
Required for submissions over 1,000 targets. Repeating the same key
and payload safely resumes or returns that submission.
requestBody:
required: true
content:
application/json:
schema:
type: object
oneOf:
- type: object
required:
- content
properties:
target:
type: string
description: Destination email address
example: person@example.com
to:
description: >-
Destination email address or array of destination email
addresses for one email
cc:
description: >-
CC email address or array of CC email addresses for one
email
bcc:
description: >-
BCC email address or array of BCC email addresses for
one email
content:
type: string
description: Email body. Raw HTML is supported.
subject:
type: string
description: Email subject line
attachments:
type: array
description: SendGrid-style attachment objects with base64 content
context:
type: string
description: Optional context for the task
taskContext:
type: string
description: Task-specific context
accountId:
type: integer
description: Optional agent account id override
agentId:
type: integer
description: Optional campaign id override
roomId:
type: string
description: Room id when replying to an existing email message
replyToMessageUuid:
type: string
description: >-
Email message uuid to reply to; used with roomId for
thread headers
scheduledFor:
type: integer
description: Unix seconds to schedule delivery
meta:
type: object
description: Optional metadata
externalTaskId:
type: string
description: >-
Reusable customer correlation/grouping ID; not an
idempotency key
contactListName:
type: string
description: Optional Contact List to enroll the contact into
- type: object
required:
- targets
properties:
targets:
description: >-
Array of email addresses or objects with per-item
options
content:
type: string
description: Email body applied to string targets
subject:
type: string
description: Subject applied to string targets
cc:
description: CC applied to string targets
bcc:
description: BCC applied to string targets
attachments:
type: array
description: Attachments applied to string targets
context:
type: string
taskContext:
type: string
accountId:
type: integer
agentId:
type: integer
scheduledFor:
type: integer
scheduleSpacingSec:
type: integer
description: >-
If provided, stagger scheduledFor by this many seconds
per index
meta:
type: object
externalTaskId:
type: string
description: >-
Reusable correlation/grouping ID applied to all created
Tasks
contactListName:
type: string
description: Contact List to enroll every contact into
responses:
'200':
description: Queued successfully
'202':
description: Large email Task submission accepted for asynchronous creation
'400':
description: Bad Request
'401':
description: Unauthorized
'500':
description: Server Error
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token

````