Skip to main content
POST
/
v1
/
conventions
Convention creation
curl --request POST \
  --url https://api.opx.co/partners/v1/conventions \
  --header 'Content-Type: application/json' \
  --data '
{
  "contract_template_id": 123,
  "installer_siret": "<string>",
  "installer_contact_email": "jsmith@example.com"
}
'
import requests

url = "https://api.opx.co/partners/v1/conventions"

payload = {
"contract_template_id": 123,
"installer_siret": "<string>",
"installer_contact_email": "jsmith@example.com"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
contract_template_id: 123,
installer_siret: '<string>',
installer_contact_email: 'jsmith@example.com'
})
};

fetch('https://api.opx.co/partners/v1/conventions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.opx.co/partners/v1/conventions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contract_template_id' => 123,
'installer_siret' => '<string>',
'installer_contact_email' => 'jsmith@example.com'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.opx.co/partners/v1/conventions"

payload := strings.NewReader("{\n \"contract_template_id\": 123,\n \"installer_siret\": \"<string>\",\n \"installer_contact_email\": \"jsmith@example.com\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.opx.co/partners/v1/conventions")
.header("Content-Type", "application/json")
.body("{\n \"contract_template_id\": 123,\n \"installer_siret\": \"<string>\",\n \"installer_contact_email\": \"jsmith@example.com\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.opx.co/partners/v1/conventions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"contract_template_id\": 123,\n \"installer_siret\": \"<string>\",\n \"installer_contact_email\": \"jsmith@example.com\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": 123,
    "contract_template_id": 123,
    "reference": "<string>",
    "rai_name": "<string>",
    "status": 123,
    "installer_name": "<string>",
    "signed_date": "<string>",
    "start_date": "<string>",
    "end_date": "<string>",
    "incentive_type": 123,
    "classic_volume": "<string>",
    "precarity_volume": "<string>",
    "is_active": true,
    "is_expired": "<string>"
  }
}
{
"message": "<string>",
"errors": {}
}

Body

application/json
contract_template_id
integer
required
installer_siret
string
required
Maximum string length: 32
installer_contact_email
string<email> | null

Response

ConventionResource

data
ConventionResource · object
required