Skip to main content
POST
/
prospects
cURL
curl --request POST \
  --url https://api.patterns.company/v1/prospects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "additional": {},
  "test": true
}
'
{
  "id": "<string>",
  "status": "enriching",
  "email": "<string>",
  "additional": {},
  "linkedin": "<string>",
  "name": "<string>",
  "company": "<string>",
  "role": "<string>",
  "industry": "<string>",
  "domain": "<string>",
  "profile": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Prospect to add to the organization

email
string
required

Email of the prospect

additional
object

Additional information about the prospect

test
boolean

Will use mock user enrichment if true

Response

prospect response

id
string<ObjectId>

ID of the prospect

status
enum<string>

Status of the prospect

Available options:
enriching,
enriched
email
string

Email of the prospect

additional
object

Additional information about the prospect

linkedin
string

LinkedIn of the prospect

name
string

Name of the prospect

company
string

Company of the prospect

role
string

Role in the company

industry
string

Industry of the company

domain
string

Domain of the company

profile
string

Combined profile of the prospect

createdAt
string<date-time>

Date and time when the prospect was created

updatedAt
string<date-time>

Date and time when the prospect was last updated