---
title: "Add Deals To List"
method: POST
path: "/lists/{audience_id}/deals"
tags: ["Lists"]
---

# Add Deals To List

`POST /lists/{audience_id}/deals`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/lists/{audience_id}/deals`
- Auth: HTTP bearer

Put deals on a deals list.

Each deal is checked against the caller's DEAL scope as well as the list's,
so adding a deal you cannot see is refused rather than silently skipped.

## Path parameters

- `audience_id` integer, required: List (audience) id.

## Headers

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

## Request body

- AddDealsToListRequest: Put deals on a deals list. Deal ids are STRINGS here while contact, company, suppression and lead ids are integers. That is the app's own typing and it is mirrored rather than smoothed over: coercing would make a mistyped id a silent miss.
  - `deal_ids` string[], required: Deal ids (strings, unlike the others).
  - `source` string, nullable: Where the addition came from, for the audit trail.

## Response `201`

Successful Response

- ApiResponseListPayload
  - `data` ListPayload, required: An open envelope for a list, a capability map or a job result. Open because several of these return the whole `Audience`, whose shape carries per-source metadata that differs between an uploaded file, a dynamic query and a master list - and grows with them.
  - `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/2e7cfa0ca921?raw)