---
title: "Start Client Map"
method: POST
path: "/api/v1/admin/client-map"
tags: ["admin"]
---

# Start Client Map

`POST /api/v1/admin/client-map`

## Request

- Base URL: `https://api.nudgelink.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.nudgelink.co/api/v1/admin/client-map`
- Auth: HTTP bearer

## Request body

- ClientMapBrief
  - `prospect_company` string
  - `prospect_person` string
  - `offer` string, required
  - `titles` string[], required
  - `company_type` string
  - `industries` string[]
  - `locations` string[]
  - `exclude_companies` string[]
  - `language` string
  - `formal` boolean
  - `sender_name` string

## Response `202`

Successful Response

- ClientMapStarted
  - `job_id` string, required

## Other responses

- `422`: Validation Error

---

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