POST
/
v1
/
worksites
curl --request POST \
  --url https://api.opx.co/partners/v1/worksites \
  --header 'Content-Type: application/json' \
  --data '{
  "external_reference": "<string>",
  "convention_id": 123,
  "beneficiary_id": 123,
  "incentive_type": "direct",
  "precarity_type": "very-low",
  "address": "<string>",
  "city": "<string>",
  "zipcode": "<string>",
  "country": "<string>",
  "additional_address": "<string>",
  "indivision": true,
  "cadastral_parcel": "<string>",
  "fiscal_informations": [
    {
      "firstname": "<string>",
      "lastname": "<string>",
      "fiscal_number": "<string>",
      "fiscal_reference": "<string>"
    }
  ]
}'
{
  "data": {
    "id": 123,
    "reference": "<string>",
    "external_reference": "<string>",
    "convention_id": 123,
    "beneficiary_id": 123,
    "installer_name": "<string>",
    "zipcode": "<string>",
    "address": "<string>",
    "city": "<string>",
    "status": "<string>",
    "created_at": "<string>",
    "precarity_type": "<string>",
    "fiscal_informations": [
      {
        "firstname": "<string>",
        "lastname": "<string>",
        "fiscal_number": "<string>",
        "fiscal_reference": "<string>"
      }
    ],
    "indivision": true
  }
}

Body

application/json
​
convention_id
integer
required
​
beneficiary_id
integer
required
​
external_reference
string | null
​
incentive_type
enum<string> | null
Available options:
direct,
indirect
​
precarity_type
enum<string> | null

type de précarité, par défaut "classic". Seul "classic" est accepté pour les chantiers b2b

Available options:
very-low,
low,
mid,
classic
​
address
string | null
​
city
string | null
​
zipcode
string | null
​
country
string | null
​
additional_address
string | null
​
indivision
boolean | null
​
cadastral_parcel
string | null

référence cadastrale de la parcelle (préfixe-section-numéro) : "O11-AD-250"

​
fiscal_informations
object[] | null

Response

200
application/json
`WorksiteResource`
​
data
object
required
Worksites listWorksite details