GEgenpage
Zapier

Create a lead through Zapier.

Changed on

Set is_test to true to have the endpoint answer with a sample page URL without importing anything — this is what Zapier calls when the user tests the step while building a Zap.

post/api/external/v1/zapier/upsert-lead

Request

Request body

workspace_idinteger required

The workspace to add the lead to.

campaign_idinteger required

The campaign to add the lead to.

is_testboolean nullable

Return a sample response instead of importing.

linkedin_profile_urlstring nullable

One of linkedin_profile_url, company_domain or email is required.

company_domainstring nullable

One of linkedin_profile_url, company_domain or email is required.

emailstring nullable

One of linkedin_profile_url, company_domain or email is required.

callback_urlstring required

Called with the generated page once the import finishes.

custom_dataobject nullable

Key/value pairs stored as variables on the lead.

Example request

{
  "workspace_id": 55,
  "campaign_id": 123,
  "linkedin_profile_url": "https://www.linkedin.com/in/williamhgates/",
  "company_domain": "example.com",
  "email": "test@example.com",
  "callback_url": "https://example.com/callback",
  "custom_data": {
    "key": "value"
  }
}

Response

OR

Example response

{
  "message": "Job started!",
  "job_id": "9f1c8b2e-..."
}

Changes

  • 29a37db12acbRevision changes
    • breaking

      added subschema #1 subschema #2 to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

  • dd3f47f72f7aRevision changes
    • info

      added the non-success response with the status

    • info

      added the success response with the status