---
title: "Preview the lead brief supplied before an outbound call"
description: "Reads current contact facts without queuing or dialing. Requires contact visibility within the authenticated workspace."
---

> Documentation Index
> Fetch the complete documentation index at: https://developer.channelautomations.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Channel Automation API › Voice AI

`POST /api/voice-campaigns/context-preview/{contactId}`

Reads current contact facts without queuing or dialing. Requires contact visibility within the authenticated workspace.

## Authentication

- `BearerAuth`, http, header `Authorization`, format `JWT`

## Path parameters

- `contactId` (`post/api/voice-campaigns/context-preview/contactId.path.contactId`; string, required)
  - format `uuid`

## Request body

_Required._

- `call_context` (`post/api/voice-campaigns/context-preview/contactId.call_context`; object, optional)
  - `enabled` (`post/api/voice-campaigns/context-preview/contactId.call_context.enabled`; boolean, optional)
  - `includeContact` (`post/api/voice-campaigns/context-preview/contactId.call_context.includeContact`; boolean, optional)
  - `template` (`post/api/voice-campaigns/context-preview/contactId.call_context.template`; string, optional)
    - maxLength 6000

## Example request

```json
{
  "call_context": {
    "enabled": true,
    "includeContact": true,
    "template": "string"
  }
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url 'https://api.channelautomation.com/api/voice-campaigns/context-preview/<contactId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "call_context": {
    "enabled": true,
    "includeContact": true,
    "template": "string"
  }
}
'
```

### TypeScript

```typescript
const url = 'https://api.channelautomation.com/api/voice-campaigns/context-preview/<contactId>';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({call_context: {enabled: true, includeContact: true, template: 'string'}})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.channelautomation.com/api/voice-campaigns/context-preview/<contactId>"

payload = { "call_context": {
        "enabled": True,
        "includeContact": True,
        "template": "string"
    } }
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Resolved brief; nothing was queued or called

#### Example

```json
{
  "success": true,
  "preview": {
    "enabled": true,
    "notes": "string",
    "missingFields": [
      "string"
    ]
  }
}
```

- `success` (`post/api/voice-campaigns/context-preview/contactId.response.200.success`; boolean, optional)
- `preview` (`post/api/voice-campaigns/context-preview/contactId.response.200.preview`; object, optional)
  - `enabled` (`post/api/voice-campaigns/context-preview/contactId.response.200.preview.enabled`; boolean, optional)
  - `notes` (`post/api/voice-campaigns/context-preview/contactId.response.200.preview.notes`; string, optional, nullable)
  - `missingFields` (`post/api/voice-campaigns/context-preview/contactId.response.200.preview.missingFields`; array<string>, optional)

### 400

Invalid context configuration

### 401

Authentication required

### 403

Contact access denied

### 404

Contact not found in this workspace

### 500

Context could not be resolved

### 503

Access could not be verified


Source: https://developer.channelautomations.com/api/post-api-voice-campaigns-context-preview-contact-id/index.md