Skip to main content

Upsert lead

POST 

/leads/_upsert

Upsert a lead. If the lead does not exist, it will be created. If the lead does exist, it will be updated. Only supported for Salesforce.

Request

Header Parameters

    x-customer-id stringrequired

    The customer ID that uniquely identifies the customer in your application

    Example: my-customer-1
    x-provider-name stringrequired

    The provider name

    Example: salesforce

Body

required
    record objectrequired
    company stringnullable
    first_name stringnullable
    last_name stringnullable
    lead_source stringnullable
    title string
    email_addresses object[]
  • Array [
  • email_address stringrequired
    email_address_type stringrequired

    Possible values: [primary, work, other]

  • ]
  • addresses object[]
  • Array [
  • address_type stringrequired

    Possible values: [primary, mailing, other, billing, shipping]

    city stringnullablerequired
    country stringnullablerequired
    postal_code stringnullablerequired
    state stringnullablerequired
    street_1 stringnullablerequired
    street_2 stringnullablerequired
  • ]
  • owner_id stringnullable
    converted_contact_id stringnullable
    converted_account_id stringnullable
    custom_fields object

    Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.

    property name* any

    Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.

    upsert_on objectrequired
    key stringrequired

    Possible values: [email]

    The key to upsert on. Only email is supported.

    values string[]required

    The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.

Responses

Lead upserted

Schema
    record object
    id stringrequired
    warnings object[]
  • Array [
  • detail string
    problem_type string
    title string
  • ]
Loading...