For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get SupportGet a demo
  • Get Started
    • Welcome
    • Quickstart
  • Webhooks
    • Introduction
    • Creating a Webhook
    • Available Webhooks
  • Public API Reference (Beta)
    • Applicants/Candidates
    • Contacts/Managers
    • Clients/Departments
        • POSTCreate an opportunity
        • DELDelete an opportunity
        • GETGet an opportunity by GUID
        • GETList opportunities
        • PUTUpdate an opportunity
  • Internal API Reference
    • Applicants/Candidates
    • Clients/Departments
    • Contacts/Managers
LogoLogo
Get SupportGet a demo
Public API Reference (Beta)OpportunitiesCore

Create an opportunity

POST
https://app.brightmove.com/ATS/api/v1/opportunities
POST
/ATS/api/v1/opportunities
$curl -X POST https://app.brightmove.com/ATS/api/v1/opportunities \
>     -H "X-Brightmove-Company-ApiKey: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "name": "Acme Corp — Q1 Staffing",
>  "clientGuid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
>  "stageName": "Proposal Sent",
>  "typeName": "Direct Hire"
>}'
201Created
1{}

Creates a new sales opportunity linked to an existing client. Required fields for creation: name, clientGuid, stageName, typeName. If closeProbability is omitted, it defaults to the stage’s configured probability. The authenticated user is automatically assigned as the primary sales representative. Requires the Manage My Opportunities or Manage Any Opportunities permission.

Was this page helpful?
Previous

Delete an opportunity

Next
Built with

Authentication

X-Brightmove-Company-ApiKeystring
BrightMove Company Api Key
X-Brightmove-User-ApiKeystring
BrightMove User Api Key

Request

This endpoint expects an object.
namestringRequired
Name of the opportunity.
clientGuidstringRequired

GUID of the client (company) to associate with this opportunity.

stageNamestringRequired
Stage name exactly as returned by the GET endpoint. Must match an existing stage configured for your company.
typeNamestringRequired
Opportunity type name exactly as returned by the GET endpoint. Must match an existing type configured for your company.
descriptionstringOptional
Detailed description of the opportunity and its objectives.
opportunityValuedoubleOptional
Estimated total deal value in USD.
closeProbabilitydoubleOptional
Estimated probability of closing this opportunity, expressed as a percentage from 0 to 100. Defaults to the stage's configured probability if omitted.
leadSourceNamestringOptional
Lead source name exactly as returned by the GET endpoint. Must match an existing lead source configured for your company.

Response

Opportunity created successfully