Create Crm Lead

POST

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

• Production
• QA

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.

Authorizations

• BearerAuth

Parameters

Path Parameters

connection_id

required

The CRM connection to act through.

string

The CRM connection to act through.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Request Body ^required

A Salesforce Lead. last_name and company are REQUIRED by Salesforce itself, which is why they are required here and not merely validated.

object

address

Any of:

CrmAddress

object

address_type

Any of:

string

string

null

null

city

Any of:

string

string

null

null

country

Any of:

string

string

null

null

postal_code

Any of:

string

string

null

null

state

Any of:

string

string

null

null

street

Any of:

string

string

null

null

street2

Any of:

string

string

null

null

null

null

annual_revenue

Any of:

number

number

null

null

company

required

string

custom_fields

Array<object>

One provider-side custom field.

field_name is the CRM’s API name, not its label. Read the valid names from GET /integrations/crm/fields; a name the provider does not have is rejected by the provider, not here.

object

field_name

required

string

field_type

Any of:

string

string

null

null

field_value

required

Required, but may be null - which is how a custom field is cleared.

email

Any of:

string

string

null

null

employee_count

Any of:

integer

integer

null

null

first_name

Any of:

string

string

null

null

industry

Any of:

string

string

null

null

last_name

required

string

lead_source

Any of:

string

string

null

null

phone

Any of:

string

string

null

null

status

Any of:

string

string

null

null

title

Any of:

string

string

null

null

user_id

Any of:

string

string

null

null

website

Any of:

string

string

null

null

Responses

201

Successful Response

object

data

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.

object

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string