contacts

Check fit on a list

Changed on

Scores each person on a list 0 to 100 against an ideal customer and its personas, with the persona each reads as and one line of why, and saves the setup on the list. Informative only: it hides and blocks nobody.

post/contacts/fit-check

Request

  • Base URL: https://api.bereach.ai
  • URL: https://api.bereach.ai/contacts/fit-check
  • Auth: HTTP bearer

Request body

campaignIdstring required

The list to check.

icpstring

Who the ideal customer is, in the user's words. Left out, the setup saved on this list is reused, else the one its search was read as; a list with neither needs it.

personasstring[]

The personas targeted, one per entry, used with icp.

rescoreboolean

Check everybody again, not only the people unchecked since the setup changed.

Response

How many people were scored

successtrue required
checkedinteger required
scoredinteger required
failedBatchesinteger required
skippedinteger required

People past the most one check reads.

startedboolean
runningboolean
refused'credits'
stoppingboolean
list_urlstring

The list in the app, to give the user.

Changes