Getting Started
Authentication
API Reference
- OAuth
- Plans
- Subscriptions
- Suppliers
- Prices
- Beta
Error Codes
- Introduction
- Error Types
Beta
Create a lead
Create a new lead
POST
/
leads
Copy
curl --request POST \
--url https://api.nomos.energy/leads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"plan": "pln_tk64byisb2oil0bmm03eggi4",
"customer": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com"
},
"address": {
"street": "Torstraße",
"house_number": "119",
"zip": "10115",
"city": "Berlin"
},
"meter": {
"number": "1APA0195124010",
"type": "smart",
"estimated_usage": 2500
},
"previous_supplier": "mp_ib7do6vpmc0c4vpbs629iybh",
"next_possible_start": true,
"intended_start_date": "2024-01-01",
"change_reason": "supplier_change",
"metadata": {
"utm_source": "google",
"utm_campaign": "campaign_name",
"user_id": "1234567890"
}
}'
Copy
{
"object": "lead",
"id": "lead_a8n8ol7yd4h0wohx824f0bui",
"link": "https://nomos.checkout.energy/?id=lead_a8n8ol7yd4h0wohx824f0bui"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
The lead to create
The body is of type object
.
Response
200
application/json
The created lead details
The response is of type object
.
Copy
curl --request POST \
--url https://api.nomos.energy/leads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"plan": "pln_tk64byisb2oil0bmm03eggi4",
"customer": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com"
},
"address": {
"street": "Torstraße",
"house_number": "119",
"zip": "10115",
"city": "Berlin"
},
"meter": {
"number": "1APA0195124010",
"type": "smart",
"estimated_usage": 2500
},
"previous_supplier": "mp_ib7do6vpmc0c4vpbs629iybh",
"next_possible_start": true,
"intended_start_date": "2024-01-01",
"change_reason": "supplier_change",
"metadata": {
"utm_source": "google",
"utm_campaign": "campaign_name",
"user_id": "1234567890"
}
}'
Copy
{
"object": "lead",
"id": "lead_a8n8ol7yd4h0wohx824f0bui",
"link": "https://nomos.checkout.energy/?id=lead_a8n8ol7yd4h0wohx824f0bui"
}
Assistant
Responses are generated using AI and may contain mistakes.