POST
/
api
/
v1
/
public
/
opportunities
cURL
curl --request POST \
  --url https://app.boxpilote.fr/api/v1/public/opportunities \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "type": "<string>",
  "origin": "<string>",
  "title": "<string>",
  "size": "<string>",
  "priority": "<string>",
  "external_id": "<string>"
}'
{
  "success": true,
  "opportunityId": "<string>"
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Data required to create an opportunity and optionally a new client

email
string
required

Customer email

first_name
string
required

Customer first name

last_name
string
required

Customer last name

phone
string
required

Customer phone number

type
string
required

Client type (Professionnel, Particulier, Association)

origin
string
required

Lead origin (Site Web)

title
string
required

Short title or description of the opportunity

size
string
required

size m2

name
string

name company

priority
string

Opportunity priority (Faible, Moyen, Important)

external_id
string

External ID of the customer

Response

Opportunity successfully created

success
boolean
opportunityId
string