Skip to main content

Update lead

PATCH 

https://api.supaglue.io/crm/v2/leads/:lead_id

Update lead

Request

Path Parameters

    lead_id stringrequired
    Example: 82de27cb-6f8c-4278-b783-82d1d916eddc

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.

Responses

Lead updated

Schema
    warnings object[]
  • Array [
  • detail string
    problem_type string
    title string
  • ]
curl -L -X PATCH 'https://api.supaglue.io/crm/v2/leads/:lead_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'x-api-key: <API_KEY_VALUE>' \
--data-raw '{
"record": {
"company": "Supaglue",
"first_name": "George",
"last_name": "Xing",
"lead_source": "API Blogger",
"title": "Co-Founder",
"email_addresses": [
{
"email_address": "hello@supaglue.com",
"email_address_type": "work"
}
],
"addresses": [
{
"address_type": "shipping",
"city": "San Francisco",
"country": "US",
"postal_code": "94107",
"state": "CA",
"street_1": "525 Brannan",
"street_2": null
}
],
"owner_id": "9f3e97fd-4d5d-4efc-959d-bbebfac079f5",
"converted_contact_id": "ad43955d-2b27-4ec3-b38a-0ca07a76d43b",
"converted_account_id": "2e1e6813-0459-47f5-ad4c-3d137c0e1fdd",
"custom_fields": {}
}
}'
Request Collapse all
Base URL
https://api.supaglue.io/crm/v2
Auth
Parameters
— pathrequired
— headerrequired
— headerrequired
Body required
{
  "record": {
    "company": "Supaglue",
    "first_name": "George",
    "last_name": "Xing",
    "lead_source": "API Blogger",
    "title": "Co-Founder",
    "email_addresses": [
      {
        "email_address": "hello@supaglue.com",
        "email_address_type": "work"
      }
    ],
    "addresses": [
      {
        "address_type": "shipping",
        "city": "San Francisco",
        "country": "US",
        "postal_code": "94107",
        "state": "CA",
        "street_1": "525 Brannan",
        "street_2": null
      }
    ],
    "owner_id": "9f3e97fd-4d5d-4efc-959d-bbebfac079f5",
    "converted_contact_id": "ad43955d-2b27-4ec3-b38a-0ca07a76d43b",
    "converted_account_id": "2e1e6813-0459-47f5-ad4c-3d137c0e1fdd",
    "custom_fields": {}
  }
}
ResponseClear

Click the Send API Request button above and see the response here!