> This page is optimized for agents. Use the linked Markdown pages and llms.txt indexes for related API content. # Create a lead list - Product: Reachiz API - Section: Lists - Snapshot: v1 - Method: `POST` - Path: `/v1/lists` ## Request body Required: yes Content types: `application/json` ### `name` Type: `string` Required: yes ## Execute with curl ```bash curl -X POST "https://prestigious-goldfish-661.convex.site/v1/lists" \ -H "Authorization: Bearer $REACHIZ_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name":""}' ``` ## Execute with TypeScript ```ts const response = await fetch("https://prestigious-goldfish-661.convex.site/v1/lists", { method: "POST", headers: { Authorization: `Bearer ${process.env.REACHIZ_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({"name":""}), }); const data = await response.json(); ``` ## Responses ### Response `201` Category: success Success #### `application/json` ##### Generated example ```json { "id": 0, "name": "name", "type": "people", "leadCount": -9007199254740991, "createdAt": "createdAt" } ``` ##### Schema ###### object Type: `object` ###### `id` Type: `number` Required: yes ###### `name` Type: `string` Required: yes ###### `type` Type: `string` Required: yes Allowed values: `people`, `companies`, `events`, `groups`, `unknown` ###### `leadCount` Type: `number` Required: yes ###### `createdAt` Type: `string` Format: `date-time` Required: yes ### Response `400` Category: client-error The request is not valid. error.fields lists each problem. #### `application/json` ##### Generated example ```json { "error": { "code": "invalid_request", "message": "message", "requestId": "requestId", "recovery": "recovery", "fields": [ { "path": "path", "message": "message" } ] } } ``` ##### Schema ###### Error Type: `Error` ###### `error` Type: `object` Required: yes ###### `code` Type: `string` Required: yes Allowed values: `invalid_request`, `not_supported`, `unauthorized`, `subscription_required`, `forbidden`, `plan_limit_exceeded`, `workspace_suspended`, `not_found`, `conflict`, `conversation_changed`, `rate_limited`, `internal`, `unavailable` ###### `message` Type: `string` Required: yes ###### `requestId` Type: `string` Required: yes ###### `recovery` Type: `string` Required: no What to do next. ###### `fields` Type: `object[]` Required: no ###### object Type: `object` ###### `path` Type: `string` Required: yes ###### `message` Type: `string` Required: yes ### Response `401` Category: client-error The API key is missing or not valid. #### `application/json` ##### Generated example ```json { "error": { "code": "invalid_request", "message": "message", "requestId": "requestId", "recovery": "recovery", "fields": [ { "path": "path", "message": "message" } ] } } ``` ##### Schema ###### Error Type: `Error` ###### `error` Type: `object` Required: yes ###### `code` Type: `string` Required: yes Allowed values: `invalid_request`, `not_supported`, `unauthorized`, `subscription_required`, `forbidden`, `plan_limit_exceeded`, `workspace_suspended`, `not_found`, `conflict`, `conversation_changed`, `rate_limited`, `internal`, `unavailable` ###### `message` Type: `string` Required: yes ###### `requestId` Type: `string` Required: yes ###### `recovery` Type: `string` Required: no What to do next. ###### `fields` Type: `object[]` Required: no ###### object Type: `object` ###### `path` Type: `string` Required: yes ###### `message` Type: `string` Required: yes ### Response `403` Category: client-error The key lacks the scope this route needs. #### `application/json` ##### Generated example ```json { "error": { "code": "invalid_request", "message": "message", "requestId": "requestId", "recovery": "recovery", "fields": [ { "path": "path", "message": "message" } ] } } ``` ##### Schema ###### Error Type: `Error` ###### `error` Type: `object` Required: yes ###### `code` Type: `string` Required: yes Allowed values: `invalid_request`, `not_supported`, `unauthorized`, `subscription_required`, `forbidden`, `plan_limit_exceeded`, `workspace_suspended`, `not_found`, `conflict`, `conversation_changed`, `rate_limited`, `internal`, `unavailable` ###### `message` Type: `string` Required: yes ###### `requestId` Type: `string` Required: yes ###### `recovery` Type: `string` Required: no What to do next. ###### `fields` Type: `object[]` Required: no ###### object Type: `object` ###### `path` Type: `string` Required: yes ###### `message` Type: `string` Required: yes ### Response `409` Category: client-error The Idempotency-Key belongs to a different request, or the state does not allow this action. #### `application/json` ##### Generated example ```json { "error": { "code": "invalid_request", "message": "message", "requestId": "requestId", "recovery": "recovery", "fields": [ { "path": "path", "message": "message" } ] } } ``` ##### Schema ###### Error Type: `Error` ###### `error` Type: `object` Required: yes ###### `code` Type: `string` Required: yes Allowed values: `invalid_request`, `not_supported`, `unauthorized`, `subscription_required`, `forbidden`, `plan_limit_exceeded`, `workspace_suspended`, `not_found`, `conflict`, `conversation_changed`, `rate_limited`, `internal`, `unavailable` ###### `message` Type: `string` Required: yes ###### `requestId` Type: `string` Required: yes ###### `recovery` Type: `string` Required: no What to do next. ###### `fields` Type: `object[]` Required: no ###### object Type: `object` ###### `path` Type: `string` Required: yes ###### `message` Type: `string` Required: yes ### Response `429` Category: client-error Too many requests. #### `application/json` ##### Generated example ```json { "error": { "code": "invalid_request", "message": "message", "requestId": "requestId", "recovery": "recovery", "fields": [ { "path": "path", "message": "message" } ] } } ``` ##### Schema ###### Error Type: `Error` ###### `error` Type: `object` Required: yes ###### `code` Type: `string` Required: yes Allowed values: `invalid_request`, `not_supported`, `unauthorized`, `subscription_required`, `forbidden`, `plan_limit_exceeded`, `workspace_suspended`, `not_found`, `conflict`, `conversation_changed`, `rate_limited`, `internal`, `unavailable` ###### `message` Type: `string` Required: yes ###### `requestId` Type: `string` Required: yes ###### `recovery` Type: `string` Required: no What to do next. ###### `fields` Type: `object[]` Required: no ###### object Type: `object` ###### `path` Type: `string` Required: yes ###### `message` Type: `string` Required: yes ### Response `503` Category: server-error The service is busy. Retry with backoff. #### `application/json` ##### Generated example ```json { "error": { "code": "invalid_request", "message": "message", "requestId": "requestId", "recovery": "recovery", "fields": [ { "path": "path", "message": "message" } ] } } ``` ##### Schema ###### Error Type: `Error` ###### `error` Type: `object` Required: yes ###### `code` Type: `string` Required: yes Allowed values: `invalid_request`, `not_supported`, `unauthorized`, `subscription_required`, `forbidden`, `plan_limit_exceeded`, `workspace_suspended`, `not_found`, `conflict`, `conversation_changed`, `rate_limited`, `internal`, `unavailable` ###### `message` Type: `string` Required: yes ###### `requestId` Type: `string` Required: yes ###### `recovery` Type: `string` Required: no What to do next. ###### `fields` Type: `object[]` Required: no ###### object Type: `object` ###### `path` Type: `string` Required: yes ###### `message` Type: `string` Required: yes ## Related representations - [Human documentation](/reachiz/sections/lists/operations/post-v1-lists/) - [curl Markdown](/reachiz/sections/lists/operations/post-v1-lists.md?lang=curl) - [TypeScript Markdown](/reachiz/sections/lists/operations/post-v1-lists.md?lang=typescript) - [site llms.txt](/llms.txt) - [product llms.txt](/reachiz/llms.txt) - [snapshot llms.txt](/reachiz/llms.txt)