Leads

Create or update leads in bulk

post

Creates or updates multiple leads. If a lead with the same email already exists, it will be updated. Optionally associate leads with a campaign.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Body

application/json

campaignIdintegerOptional

Responses

201

Leads processed successfully

application/json

400

Invalid request body or no leads provided

application/json

401

Unauthorized - invalid or missing API key

application/json

404

Campaign not found

application/json

500

Failed to create leads

application/json

post

/leads

HTTPcURLJavaScriptPython

POST /r/leads HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "campaignId": 1,
  "leads": [
    {
      "company": "text",
      "email": "text",
      "firstName": "text",
      "lastName": "text",
      "linkedin": "text",
      "phone": "text",
      "title": "text",
      "website": "text"
    }
  ]
}

{
  "count": 5,
  "message": "leads processed successfully"
}

Get a lead by ID

get

Retrieves detailed information about a specific lead.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Lead ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Responses

200

Lead details

application/json

400

Invalid lead ID

application/json

401

Unauthorized - invalid or missing API key

application/json

403

Forbidden - lead does not belong to your space

application/json

404

Lead not found

application/json

get

/leads/{id}

HTTPcURLJavaScriptPython

GET /r/leads/{id} HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Accept: */*

{
  "lead": {
    "company": "Acme Corp",
    "createdAt": "2024-01-15T10:30:00Z",
    "email": "[email protected]",
    "firstName": "John",
    "id": 123,
    "lastName": "Doe",
    "linkedin": "https://linkedin.com/in/johndoe",
    "phone": "[phone]",
    "title": "Software Engineer",
    "updatedAt": "2024-01-15T10:30:00Z",
    "website": "https://example.com"
  }
}

Update a lead by ID

put

Updates an existing lead's information. Only provided fields will be updated.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Lead ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Body

application/json

companystringOptional

emailstringOptional

firstNamestringOptional

lastNamestringOptional

linkedinstringOptional

phonestringOptional

titlestringOptional

websitestringOptional

Responses

200

Lead updated successfully

application/json

400

Invalid lead ID or request body

application/json

401

Unauthorized - invalid or missing API key

application/json

403

Forbidden - lead does not belong to your space

application/json

404

Lead not found

application/json

500

Failed to update lead

application/json

put

/leads/{id}

HTTPcURLJavaScriptPython

PUT /r/leads/{id} HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "company": "text",
  "email": "text",
  "firstName": "text",
  "lastName": "text",
  "linkedin": "text",
  "phone": "text",
  "title": "text",
  "website": "text"
}

{
  "lead": {
    "company": "Acme Corp",
    "createdAt": "2024-01-15T10:30:00Z",
    "email": "[email protected]",
    "firstName": "John",
    "id": 123,
    "lastName": "Doe",
    "linkedin": "https://linkedin.com/in/johndoe",
    "phone": "[phone]",
    "title": "Software Engineer",
    "updatedAt": "2024-01-15T10:30:00Z",
    "website": "https://example.com"
  },
  "message": "lead updated successfully"
}

Delete a lead by ID

delete

Deletes a lead and all associated unsent emails. If the lead is associated with campaigns, it will be removed from those campaigns first.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

idintegerRequired

Lead ID

Header parameters

AuthorizationstringRequired

Bearer <API_KEY>

Responses

200

Lead deleted successfully

application/json

400

Invalid lead ID

application/json

401

Unauthorized - invalid or missing API key

application/json

403

Forbidden - lead does not belong to your space

application/json

404

Lead not found

application/json

500

Failed to delete lead

application/json

delete

/leads/{id}

HTTPcURLJavaScriptPython

DELETE /r/leads/{id} HTTP/1.1
Host: api.emailchaser.com
Authorization: text
Accept: */*

{
  "id": 123,
  "message": "lead deleted successfully"
}