Add Lead to Campaign

Adds a single lead to a lead source (campaign). Supports three import types: username (Twitter handle), profile_url (x.com profile URL), or json (full Twitter user object).

Lead Credits: Adding a lead by username or profile_url consumes Lead Credits, as the system looks up the Twitter profile. Adding by json does not consume Lead Credits.

POST /lead-sources/{id}/lead

Add lead to campaign

cURL

curl --request POST \
  --url https://app.drippi.ai/api/v1/lead-sources/{id}/lead \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "importType": "username",
  "username": "<string>",
  "customVariables": {}
}
'

import requests

url = "https://app.drippi.ai/api/v1/lead-sources/{id}/lead"

payload = {
    "importType": "username",
    "username": "<string>",
    "customVariables": {}
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({importType: 'username', username: '<string>', customVariables: {}})
};

fetch('https://app.drippi.ai/api/v1/lead-sources/{id}/lead', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.drippi.ai/api/v1/lead-sources/{id}/lead",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'importType' => 'username',
    'username' => '<string>',
    'customVariables' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.drippi.ai/api/v1/lead-sources/{id}/lead"

	payload := strings.NewReader("{\n  \"importType\": \"username\",\n  \"username\": \"<string>\",\n  \"customVariables\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.drippi.ai/api/v1/lead-sources/{id}/lead")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"importType\": \"username\",\n  \"username\": \"<string>\",\n  \"customVariables\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.drippi.ai/api/v1/lead-sources/{id}/lead")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"importType\": \"username\",\n  \"username\": \"<string>\",\n  \"customVariables\": {}\n}"

response = http.request(request)
puts response.read_body

200

{
  "status": "success",
  "message": "Lead added successfully",
  "lead": "<unknown>",
  "data": "<unknown>"
}

{
  "status": "error",
  "message": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "status": "error",
  "message": "Something went wrong"
}

{
  "status": "error",
  "message": "Something went wrong"
}

{
  "code": "RATE_LIMITED",
  "message": "Rate limit exceeded",
  "ratelimit": {
    "remaining": 123,
    "limit": 123,
    "duration": 123,
    "reset": 123
  }
}

{
  "status": "error",
  "message": "Something went wrong"
}

Adds a single lead to a lead source (campaign). You can add a lead in three ways:

• By username — Pass a Twitter username; the system looks up the profile. Consumes Lead Credits.
• By profile URL — Pass an x.com profile URL (e.g. https://x.com/username); the username is extracted and the profile is looked up. Consumes Lead Credits.
• By JSON — Pass a full Twitter user object. Does not consume Lead Credits.

The username and profile_url import options use Lead Credits. Use json when you already have the user data (e.g., via the enrichment API) to avoid spending Lead Credits.

Authorizations

x-api-key · string · header · required

API key for authentication

Path Parameters

id · string · required

Lead Source ID (campaign ID)

Body

application/json

Option 1

Option 2

Option 3

Request body for adding a lead. Use one of: username (consumes Lead Credits), profile_url (consumes Lead Credits), or json (no Lead Credits).

importType · enum<string> · required

Import by Twitter username. Consumes Lead Credits.

Available options: username

username · string · required

Twitter username (without @)

customVariables · object

Optional key-value pairs for personalization

Show child attributes

Response

200

application/json

Lead added successfully

status · string

Example:

"success"

message · string

Example:

"Lead added successfully"

lead · any

Lead data (for username/profile_url imports)

data · any

Response data (for json import)