---
title: "Create Session Draft"
method: POST
path: "/dialer/sessions/draft"
tags: ["Dialer"]
---

# Create Session Draft

`POST /dialer/sessions/draft`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/dialer/sessions/draft`
- Auth: HTTP bearer

CONTACTS NOBODY. Creates a DRAFT session and dials no one.

The safe first step: it resolves the list or sequence, snapshots the
filter, and stops. `POST /dialer/sessions/{id}/next-batch` is what turns a
draft into ringing telephones.

Not idempotent in the way it looks: voice REUSES a live session for the
same list rather than creating a second one, so calling this twice does
not double-dial - it returns the existing session. `from_phone` is
optional here and enforced at dial time.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- SessionDraftRequest: Mirrors `CreateBeQueueSessionRequest` minus `org_id`. Either `list_id` or `sequence_id` is required - voice 400s with neither, and that is left to voice rather than duplicated here so the two cannot disagree about which combinations are legal.
  - `user_id` string, required
  - `user_email` string, nullable
  - `list_id` string, nullable
  - `sequence_id` string, nullable
  - `sequence_step_order` integer, nullable
  - `filter_spec` FilterSpec: Which contacts in the list are eligible to be dialed. Narrowing this on a RUNNING session changes who gets called next. It is not a display filter.
    - `search` string, nullable
    - `predicates` FilterPredicate[]
      - `field` string, required
      - `op` string, required
      - `value` unknown
      - `values` unknown[], nullable
        - unknown
      - `conditions` object[], nullable: Nested predicates for AND/OR groups. Each entry has the same shape as this object: field, op, value, values and, optionally, its own conditions.
    - `exclude_dispositions` string[]
  - `order_spec` OrderSpec: The order the queue is worked in, and which phone field is tried first.
    - `mode` 'natural_skip_dialed' | 'dialed_first'
    - `phone_priority` string[]
    - `sort_model` object[]
  - `parallel_count` integer
  - `from_phone` string, nullable
  - `agent_id` string, nullable
  - `entity_type` string, nullable
  - `dialing_mode` 'power' | 'parallel', nullable
  - `campaign_id` string, nullable
  - `campaign_builder_campaign_id` string, nullable
  - `name` string, nullable
  - `user_timezone` string, nullable
  - `list_title` string, nullable
  - `selected_event_type_id` integer, nullable

## Response `201`

Successful Response

- ApiResponseDialerPayload
  - `data` DialerPayload, required: An open envelope for one dialer result. Open because voice owns the shape of a session, a call stub and a queue stat, and it grows them without a contract bump here. A dropped field would otherwise turn an added upstream field into a removed public one.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)