---
title: "Create Crm Lead"
method: POST
path: "/integrations/crm/connections/{connection_id}/leads"
tags: ["Integrations"]
---

# Create Crm Lead

`POST /integrations/crm/connections/{connection_id}/leads`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/integrations/crm/connections/{connection_id}/leads`
- Auth: HTTP bearer

Create a Lead IN THE CUSTOMER'S SALESFORCE.

`last_name` and `company` are required by Salesforce itself. `status` is an
OPEN picklist - read the valid values from
`GET /integrations/crm-sync/leads/statuses` first, because an invented one
is stored rather than refused.

## Path parameters

- `connection_id` string, required: The CRM connection to act through.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- LeadCreateRequest: A Salesforce Lead. `last_name` and `company` are REQUIRED by Salesforce itself, which is why they are required here and not merely validated.
  - `first_name` string, nullable
  - `last_name` string, required
  - `email` string, nullable
  - `phone` string, nullable
  - `title` string, nullable
  - `company` string, required
  - `status` string, nullable: Salesforce `Lead.Status` API name. Read the valid values from `GET /integrations/crm-sync/leads/statuses` - it is an OPEN picklist, so an invented value silently becomes a real status.
  - `lead_source` string, nullable
  - `industry` string, nullable
  - `website` string, nullable
  - `employee_count` integer, nullable
  - `annual_revenue` number, nullable
  - `address` CrmAddress
    - `street` string, nullable
    - `street2` string, nullable
    - `city` string, nullable
    - `state` string, nullable
    - `postal_code` string, nullable
    - `country` string, nullable
    - `address_type` string, nullable
  - `user_id` string, nullable
  - `custom_fields` CrmCustomField[]
    - `field_name` string, required
    - `field_value` unknown, required
    - `field_type` string, nullable

## Response `201`

Successful Response

- ApiResponseCrmPayload
  - `data` CrmPayload, required: One CRM record, or one provider response. Open-shaped ON PURPOSE. These bodies carry whatever the provider returned, the field set differs between HubSpot, Salesforce, Pipedrive and SugarCRM, and it grows every time one of them ships something. Pinning it would drop whatever a provider reported that this contract had not caught up on - which on a CRM surface means silently hiding the customer's own data from them.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

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