GEgenpage
Leads

Upsert (update or create) a single lead.

Changed on

This endpoint is used to upsert a single lead.

The "values" object requires at least one of the following fields, otherwise it will throw an error:

  • first_name
  • email
  • company_name
  • company_domain
  • linkedin_profile_url
post/api/external/v1/leads/upsert-lead

Request

Request body

fromstring nullable

The service that is sending the lead, use your own company/service name please. Defaults to NOT_SPECIFIED.

campaign_idinteger required

The campaign ID to add the lead to.

audience_idinteger nullable

An audience to add the lead to.

callback_urlstring nullable

Optional callback URL.

send_emailboolean nullable

Send the configured email for the upserted lead. Defaults to false.

is_generate_ai_analysisboolean nullable

Whether to generate AI analysis for the lead.

enrich_databoolean nullable

Enrich the lead from their email/domain.

generate_ai_variablesboolean nullable

Generate AI variable values for the lead. Defaults to false.

lead_idinteger nullable

The GenPage Lead ID for updating existing leads.

genpage_urlstring nullable

The GenPage URL for updating existing leads.

valuesobject nullable required

Object containing key/value pairs with the lead data. You can send any key/value (value can be a string or a number) pairs that you want to add to the lead.

Example request

{
  "from": "MyCompanyName",
  "campaign_id": 1,
  "audience_id": 1,
  "callback_url": "https://example.com/callback",
  "is_generate_ai_analysis": true,
  "lead_id": 16,
  "genpage_url": "https://myworkspace.genpa.ge/aws-john",
  "values": {
    "first_name": "John",
    "email": "john@aws.com",
    "company_name": "Amazon Web Services",
    "linkedin_profile_url": "https://www.linkedin.com/in/john-doe-1234567890"
  }
}

Response

job_idstring

Example response

{
  "job_id": "9f1c8b2e-..."
}

Changes

  • 29a37db12acbRevision changes
    • info

      the request property became optional

  • dd3f47f72f7aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status