Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
agent_id
string<uuid>
required

The UUID of the voice agent that will place the call.

requested_at
string<date-time>
required

The earliest time the call may be placed. Accepts ISO 8601 format with a timezone offset (e.g. '2026-08-03T14:30:00Z' or '2026-08-03T09:30:00-05:00'). A time in the past means as soon as the agent's calling hours allow. May be at most 90 days in the future.

contact
object
required

The contact to call. Alpharun uses the external ID, phone number, or email to find or create the contact. A phone number is required.

expires_at
string<date-time>

The time past which the call is no longer worth placing, for example because the appointment it is about has happened. If no call can be placed before it, the task fails instead of calling late. Defaults to five days after requested_at, and must be after it.

custom_fields
object[]

Custom fields to set on the customer interaction created for this call. Each key must match the field_name of a Customer interaction custom field defined in your Alpharun dashboard; entries whose keys don't match a definition are ignored.

ext_id
string

Your identifier for the call task, such as an appointment ID. Reusing it returns the existing task while it is active. After the task ends, the ID can be reused if the agent allows re-enrollment.

Maximum string length: 255

Response

An existing task was returned; no new task was created.

data
object