Skip to main content
POST
/
contact-lists
/
{id}
/
analyze
Analyze Contact List
curl --request POST \
  --url https://api.politicalcomms.com/v1/contact-lists/{id}/analyze \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{}'
{
  "success": true,
  "data": {
    "id": "cl_abc123",
    "analysis_status": "queued",
    "queued_at": "2025-03-15T10:10:00Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy.

Path Parameters

​
id
string
required

Resource ID

Body

application/json

The body is of type object.

Response

Analysis queued