# Aim a blast at a board

Aims a draft blast at the people on a board in ONE call — the way to give a blast its audience. It works on ANY board the caller can open — Leads, Deals, Merchants, Lenders, Agents, Contacts, or one somebody made — as long as it has a column holding phone numbers (text blast) or email addresses (email blast). That need not be a column of the phone or email kind: an imported board often keeps them in a plain text or number column, and `addressColumnId` may name any text or number column that does. Body: `definitionKey` (the board, e.g. "leads"), an optional `addressColumnId` (which phone or email column to send to, when the board has several — absent takes the board's own default), and a filter, at least one of which must pick somebody: the GRID'S filter — `q` and `filters` ({column label or id: [values]}, exactly what get_definitions_key_rows and post_definitions_key_rows_act take: a status by its word or tab, any column a computed one included, `$` keys; `{"filters": {"Documents": ["complete"]}}` is everyone not missing docs) — or the older `statuses` (only on a board that has a status column), `tags`, `search` (text found in any cell), `rowIds`, folded into the same filter. A column the board does not have is refused by name. The service finds the matching rows the caller may see, takes each one's phone (text blast) or email (email blast), leaves out anyone marked do-not-contact, and freezes each recipient's merge values beside the address so the blast's `{{fields}}` can be filled per person. It answers `matched` (rows the filter found), `skippedNoAddress` (of those, the ones with nothing in the address column — counted, never dropped in silence), `requested` (those with an address for this kind), `changed` (added by this call), `truncated` (true past 2,500 a call), `noSelection` (the request picked nobody — different from matching nobody), only the `refused` addresses with why, `fields` — the merge-field names this audience can fill — and `addressColumns`, the columns it is most likely addressed from, with the default marked. Draft-only and append-only: a mis-aimed list is fixed by cancelling the draft and building another. Then read `get_blasts_id_preview`.

Access class: `workspace`.

## Endpoint

`POST /v1/blasts/{id}/audience/board`

## Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| id | path | string | Yes |

## Request body

Content type: `application/json`.

```json
{
  "addressColumnId": "",
  "definitionKey": "string",
  "filters": {},
  "q": "string",
  "rowIds": [
    "string"
  ],
  "search": "string",
  "statuses": [
    "string"
  ],
  "tags": [
    "string"
  ]
}
```

## Responses

### 201

the action's answer

Content type: `application/json`.

```json
{
  "data": {
    "addressColumns": [
      {
        "default": "string",
        "id": "",
        "kind": "string",
        "label": "string"
      }
    ],
    "changed": 1,
    "failed": 1,
    "fields": [
      {
        "group": "string",
        "label": "string",
        "name": "string"
      }
    ],
    "matched": 1,
    "noSelection": true,
    "refused": [
      {
        "address": "string",
        "changed": "string",
        "error": "string",
        "ok": "string"
      }
    ],
    "requested": 1,
    "skippedNoAddress": 1,
    "succeeded": 1,
    "truncated": true
  }
}
```

### default

a refusal: `{"error": "<what a person needs to read>"}`. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

Content type: `application/json`.

```json
{
  "error": "string"
}
```
