Skip to main content

Input fields

addressDetails : String

The customer's address details; e.g. the building floor.

city : String! required

The customer's address city.

finalUserName : String

The actual or previous customer's name.

inseeCode : String

The insee code of the city.

marketName : String! required

The market name.

outOfSupplierPerimeter : Boolean

True if the address is out of the supplier perimeter.

postcode : String! required

The customer's address postcode.

serialNumber : String

The customer's meter point serial number.

streetName : String! required

The customer's address street name.

streetNumber : String

The customer's address street number.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "addressDetails": "meeting-hospital-time-loss-can", "city": "spring-model-next-such-ok", "finalUserName": "mind-air-woman-yard-sea", "inseeCode": "customer-home-food-important-call", "marketName": "ask-feel-sometimes-move-individual", "outOfSupplierPerimeter": true, "postcode": "five-evening-see-minute-across", "serialNumber": "business-first-risk-six-of", "streetName": "later-evidence-law-hair-score", "streetNumber": "herself-threat-back-often-argue" }