Skip to main content
POST
/
api
/
opportunities
Create Opportunity Endpoint
curl --request POST \
  --url https://api.example.com/api/opportunities \
  --header 'Content-Type: application/json' \
  --data '
{
  "company": "<string>",
  "contact_name": "<string>",
  "role_title": "<string>",
  "contact_linkedin": "<string>",
  "contact_title": "<string>",
  "follow_up_date": "<string>",
  "job_url": "<string>",
  "location": "<string>",
  "notes": "<string>",
  "salary_range": "<string>",
  "source_id": "<string>",
  "status": "interested"
}
'
{
  "company": "<string>",
  "contact_name": "<string>",
  "created_at": "<string>",
  "id": "<string>",
  "role_title": "<string>",
  "status": "interested",
  "updated_at": "<string>",
  "contact_linkedin": "<string>",
  "contact_title": "<string>",
  "follow_up_date": "<string>",
  "job_url": "<string>",
  "location": "<string>",
  "notes": "<string>",
  "salary_range": "<string>",
  "source_id": "<string>"
}

Body

application/json

Request to create an opportunity.

​
company
string
required
Minimum string length: 1
​
contact_name
string
required
Minimum string length: 1
​
role_title
string
required
Minimum string length: 1
​
contact_linkedin
string | null
​
contact_title
string | null
​
follow_up_date
string | null
​
job_url
string | null
​
location
string | null
​
notes
string | null
​
salary_range
string | null
​
source_id
string | null
​
status
enum<string>
default:interested
Available options:
interested,
applied,
interviewing,
offer,
rejected,
archived

Response

Successful Response

Full opportunity entity.

​
company
string
required
​
contact_name
string
required
​
created_at
string
required
​
id
string
required
​
role_title
string
required
​
status
enum<string>
required
Available options:
interested,
applied,
interviewing,
offer,
rejected,
archived
​
updated_at
string
required
​
contact_linkedin
string | null
​
contact_title
string | null
​
follow_up_date
string | null
​
job_url
string | null
​
location
string | null
​
notes
string | null
​
salary_range
string | null
​
source_id
string | null