/leads

curl -X POST https://api.merge.dev/api/crm/v1/leads \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "model": {}
}'

{
  "model": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "remote_id": "19202938",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
    "owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
    "lead_source": "API Blogger",
    "title": "Co-Founder",
    "company": "Merge API",
    "first_name": "Gil",
    "last_name": "Feig",
    "addresses": [
      {
        "created_at": "2021-09-15T00:00:00Z",
        "modified_at": "2021-10-16T00:00:00Z",
        "street_1": "50 Bowling Green Dr",
        "street_2": "Golden Gate Park",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94122",
        "country": "US",
        "address_type": "BILLING"
      }
    ],
    "email_addresses": [
      {
        "email_address": "hello@merge.dev",
        "email_address_type": "Work"
      }
    ],
    "phone_numbers": [
      {
        "created_at": "2021-09-15T00:00:00Z",
        "modified_at": "2021-10-16T00:00:00Z",
        "phone_number": "+16789932455",
        "phone_number_type": "Mobile"
      }
    ],
    "remote_updated_at": "2022-02-10T00:00:00Z",
    "remote_created_at": "2021-11-10T00:00:00Z",
    "converted_date": "2022-03-10T00:00:00Z",
    "converted_contact": "025fjlc6-6000-430a-848e-aafacbadf4fe",
    "converted_account": "9c9de072-29cf-48e3-9578-1ca5b145b40e",
    "status": "OPEN",
    "remote_was_deleted": true,
    "field_mappings": {
      "organization_defined_targets": {
        "custom_key": "custom_value"
      },
      "linked_account_defined_targets": {
        "custom_key": "custom_value"
      }
    },
    "remote_data": [
      {
        "path": "/leads"
      }
    ],
    "remote_fields": [
      {
        "remote_field_class": {
          "id": "string",
          "display_name": "string",
          "remote_key_name": "string",
          "description": "string",
          "is_custom": true,
          "is_common_model_field": true,
          "is_required": true,
          "field_type": "string",
          "field_format": "string",
          "field_choices": [
            "string"
          ],
          "item_schema": {
            "item_type": "string",
            "item_format": "string",
            "item_choices": [
              "string"
            ]
          }
        },
        "value": "string"
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Creates a Lead object with the given values.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

Description

The Lead object is used to represent an individual who is a potential customer.

Usage Example

TODO

Response

modelobject

Description

The Lead object is used to represent an individual who is a potential customer.

Usage Example

TODO

warningslist of objects

errorslist of objects

logslist of objects or null

Supported POST model parameters

titlestring or nullRequired

The lead's title.

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The lead's owner.

lead_sourcestring or nullOptional

The lead's source.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

Supported POST model parameters

companystring or nullRequired

The lead's company.

last_namestring or nullRequired

The lead's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

first_namestring or nullOptional

The lead's first name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_datedatetime or nullOptional

When the lead was converted.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

remote_fieldslist of objectsOptionalRead-only

Supported POST model parameters

last_namestring or nullRequired

The lead's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_datedatetime or nullOptional

When the lead was converted.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

statusenum or nullOptional

The lead’s status.

OPEN - OPEN
CLOSED - CLOSED
UNQUALIFIED - UNQUALIFIED
QUALIFIED - QUALIFIED

Allowed values:

remote_fieldslist of objectsOptionalRead-only

Supported POST model parameters

titlestring or nullRequired

The lead's title.

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The lead's owner.

lead_sourcestring or nullOptional

The lead's source.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

last_namestring or nullOptional

The lead's last name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

Supported POST model parameters

companystring or nullRequired

The lead's company.

last_namestring or nullRequired

The lead's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

first_namestring or nullOptional

The lead's first name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_datedatetime or nullOptional

When the lead was converted.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

remote_fieldslist of objectsOptionalRead-only

Supported POST model parameters

last_namestring or nullRequired

The lead's last name.

remote_idstring or nullOptional

The third-party API ID of the matching object.

ownerstring or nullOptionalformat: "uuid"

The lead's owner.

lead_sourcestring or nullOptional

The lead's source.

titlestring or nullOptional

The lead's title.

companystring or nullOptional

The lead's company.

first_namestring or nullOptional

The lead's first name.

addresseslist of objectsOptionalRead-only

email_addresseslist of objectsOptionalRead-only

phone_numberslist of objectsOptionalRead-only

remote_updated_atdatetime or nullOptional

When the third party's lead was updated.

remote_created_atdatetime or nullOptional

When the third party's lead was created.

converted_datedatetime or nullOptional

When the lead was converted.

converted_contactstring or nullOptionalformat: "uuid"

The contact of the converted lead.

converted_accountstring or nullOptionalformat: "uuid"

The account of the converted lead.

statusenum or nullOptional

The lead’s status.

OPEN - OPEN
CLOSED - CLOSED
UNQUALIFIED - UNQUALIFIED
QUALIFIED - QUALIFIED

Allowed values:

remote_fieldslist of objectsOptionalRead-only

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Field support by integration