Import selected prospects - Sendora

POST

/

api

/

v1

/

public

/

lead-lists

/

{list_id}

/

prospect-search

/

preview

/

{preview_id}

/

commit

cURL

curl -X POST 'https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview/YOUR_ID/commit' -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
  -d '{"person_ids":["example"]}'

import requests

url = 'https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview/YOUR_ID/commit'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.post(url, headers=headers, json={'person_ids': ['example']})
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview/YOUR_ID/commit", {
  method: "POST",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"person_ids": ["example"]}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("POST", "https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview/YOUR_ID/commit", bytes.NewBufferString(`{"person_ids": ["example"]}`))
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "already_in_other_lists_count": 123,
  "new_leads_count": 123,
  "updated_leads_count": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key

string | null

Authorization

string | null

Path Parameters

list_id

string

required

The lead list's id: the id from List lead lists. It is also the last part of that page's address in the app.

preview_id

string<uuid>

required

The preview's id: the id returned by Preview prospect search results. It identifies that one preview and is not shown in the app.

Body

application/json

person_ids

string[]

required

The people to import: id values from the results of the preview.

Required array length: 1 - 100 elements

auto_enrich

boolean

default:true

Auto enrich returned by the Sendora API.

enrich_fields

string[] | null

Enrich fields returned by the Sendora API.

Response

Successful Response

already_in_other_lists_count

integer

required

Already in other lists count returned by the Sendora API.

new_leads_count

integer

required

New leads count returned by the Sendora API.

updated_leads_count

integer

required

Updated leads count returned by the Sendora API.

cURL

curl -X POST 'https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview/YOUR_ID/commit' -H "X-API-Key: $SENDORA_API_KEY" -H "Content-Type: application/json" \
  -d '{"person_ids":["example"]}'

import requests

url = 'https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview/YOUR_ID/commit'
headers = {'X-API-Key': '$SENDORA_API_KEY'}
response = requests.post(url, headers=headers, json={'person_ids': ['example']})
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview/YOUR_ID/commit", {
  method: "POST",
  headers: { 'X-API-Key': process.env.SENDORA_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({"person_ids": ["example"]}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

req, err := http.NewRequest("POST", "https://api.sendora.ai/api/v1/public/lead-lists/YOUR_ID/prospect-search/preview/YOUR_ID/commit", bytes.NewBufferString(`{"person_ids": ["example"]}`))
if err != nil { log.Fatal(err) }
req.Header.Set("X-API-Key", os.Getenv("SENDORA_API_KEY"))
req.Header.Set("Content-Type", "application/json")
resp, err := http.DefaultClient.Do(req)
if err != nil { log.Fatal(err) }
defer resp.Body.Close()

{
  "already_in_other_lists_count": 123,
  "new_leads_count": 123,
  "updated_leads_count": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}