Replace the ideal client profile

Changes the user's ideal client profile (ICP), which decides who counts as a lead. Replaces the ideal client: the include rules (who fits) and the exclude rules (who never fits). The rules cover job titles, seniorities, industries, company sizes, countries and more. A rule left out becomes empty, so start from get_icp and send back every rule you want to keep. Ziplined scores everyone again in the background. The answer gives the saved profile as a sentence, and how many people are a lead under it. It also gives the run that rescores them: poll it with refresh_data and its run_id. Costs no credits. Use when: After get_icp, when the user wants to change who counts as a lead. Do not use for: Only changing who never fits (use save_exclusions instead). Marking one person not a fit (use update_person instead). Rescoring without a change (use refresh_data instead). Example: {"include":{"seniorities":["C-Level","Founder"],"industries":["Software Development"],"countries":["NL"]},"exclude":{"job_titles":["recruiter"]}}

PUT

icp

curl --request PUT \
  --url https://api.ziplined.io/v1/icp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "include": {},
  "exclude": {}
}
'

import requests

url = "https://api.ziplined.io/v1/icp"

payload = {
    "include": {},
    "exclude": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({include: {}, exclude: {}})
};

fetch('https://api.ziplined.io/v1/icp', 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://api.ziplined.io/v1/icp",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'include' => [
        
    ],
    'exclude' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.ziplined.io/v1/icp"

	payload := strings.NewReader("{\n  \"include\": {},\n  \"exclude\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.ziplined.io/v1/icp")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"include\": {},\n  \"exclude\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ziplined.io/v1/icp")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"include\": {},\n  \"exclude\": {}\n}"

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

{
  "icp": {
    "is_set": true,
    "sentence": "<string>",
    "include": {
      "job_titles": [
        "<string>"
      ],
      "seniorities": [
        "C-Level"
      ],
      "industries": [
        "<string>"
      ],
      "company_sizes": [
        {
          "min": 2,
          "max": 2
        }
      ],
      "countries": [
        "<string>"
      ],
      "bio_keywords": [
        "<string>"
      ],
      "skills": [
        "<string>"
      ],
      "languages": [
        "<string>"
      ],
      "is_premium": true,
      "min_followers": 1,
      "min_connections": 1
    },
    "exclude": {
      "job_titles": [
        "<string>"
      ],
      "seniorities": [
        "C-Level"
      ],
      "industries": [
        "<string>"
      ],
      "company_sizes": [
        {
          "min": 2,
          "max": 2
        }
      ],
      "countries": [
        "<string>"
      ],
      "bio_keywords": [
        "<string>"
      ],
      "skills": [
        "<string>"
      ],
      "languages": [
        "<string>"
      ]
    }
  },
  "impact": {
    "leads": 123,
    "people": 123,
    "summary": "<string>"
  },
  "rescore_run_id": "<string>",
  "app_url": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

idempotency-key

string

Any client-chosen key, a uuid for example. Sending the same request twice with the same key has one effect and returns the same response twice; the same key with a different body returns 409.

Required string length: 1 - 255

Example:

"3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

Body

application/json

include

object

Who fits. A field left out is empty ("any").

Show child attributes

exclude

object

Who never fits. A field left out is empty.

Show child attributes

Response

The result

icp

object

required

Show child attributes

impact

object

required

A count from stored data, without scraping, by the same scorer the lists use. Lists update in the background.

Show child attributes

rescore_run_id

string | null

required

The run that rescores everyone; poll it with refresh_data run_id.

app_url

string

required

Replace the ideal client profile

curl --request PUT \
  --url https://api.ziplined.io/v1/icp \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "include": {},
  "exclude": {}
}
'

import requests

url = "https://api.ziplined.io/v1/icp"

payload = {
    "include": {},
    "exclude": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({include: {}, exclude: {}})
};

fetch('https://api.ziplined.io/v1/icp', 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://api.ziplined.io/v1/icp",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'include' => [
        
    ],
    'exclude' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.ziplined.io/v1/icp"

	payload := strings.NewReader("{\n  \"include\": {},\n  \"exclude\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.put("https://api.ziplined.io/v1/icp")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"include\": {},\n  \"exclude\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ziplined.io/v1/icp")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"include\": {},\n  \"exclude\": {}\n}"

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

{
  "icp": {
    "is_set": true,
    "sentence": "<string>",
    "include": {
      "job_titles": [
        "<string>"
      ],
      "seniorities": [
        "C-Level"
      ],
      "industries": [
        "<string>"
      ],
      "company_sizes": [
        {
          "min": 2,
          "max": 2
        }
      ],
      "countries": [
        "<string>"
      ],
      "bio_keywords": [
        "<string>"
      ],
      "skills": [
        "<string>"
      ],
      "languages": [
        "<string>"
      ],
      "is_premium": true,
      "min_followers": 1,
      "min_connections": 1
    },
    "exclude": {
      "job_titles": [
        "<string>"
      ],
      "seniorities": [
        "C-Level"
      ],
      "industries": [
        "<string>"
      ],
      "company_sizes": [
        {
          "min": 2,
          "max": 2
        }
      ],
      "countries": [
        "<string>"
      ],
      "bio_keywords": [
        "<string>"
      ],
      "skills": [
        "<string>"
      ],
      "languages": [
        "<string>"
      ]
    }
  },
  "impact": {
    "leads": 123,
    "people": 123,
    "summary": "<string>"
  },
  "rescore_run_id": "<string>",
  "app_url": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

People

Companies

Posts

Engagements

Insights

Views

Audiences

ICP

Sources

Account

Credits

Integrations

Replace the ideal client profile

Authorizations

Headers

Body

Response