Skip to main content
POST
Enroll a single contact

Authorizations

x-api-key
string
header
required

Organization API key. Get it from the 11x team or from the platform.

Path Parameters

agentId
string
required

ID of the agent, e.g. agent.abc123.

Body

application/json

In addition to the fields below, include every custom input variable required by the agent as a top-level string property (e.g. prospect_name, account_id). The exact set varies per agent and is configured on the agent's prompt template.

name
string
required

Contact's full name.

Example:

"John Doe"

phoneNumber
string
required

Contact's phone number in E.164 format.

Example:

"+15551234567"

toEmailAddress
string<email>

Recipient email address. Required when the agent's sequence contains email steps.

timezone
string

IANA timezone (e.g. America/New_York). If omitted, inferred from the phone number's area code, falling back to the agent's first configured timezone.

scheduledAt
string<date-time>

Schedule the call for a specific future time (ISO 8601). Validated against the same timezone the scheduler uses for execution.

bypassAllowedCallWindow
boolean
default:false

Bypass the agent's allowed call windows for this sequence.

groupByField
string

Group this contact with others sharing the same value of the named custom variable. Used for contact chaining — only the first contact per group is scheduled; the rest are chained automatically when the previous call ends without success.

Example:

"account_id"

{key}
string

Custom input variables defined on the agent.

Response

Sequence scheduled.

sequence
object
required