CLclevergy
Houses

Create a house

Create a new house for the user

post/users/{userId}/houses

Request

  • Base URL
    https://connect.clever.gy
  • Auth
    API key in header clevergy-api-key

Path parameters

userIdstring required

ID of user

Request body

addressstring

House address (should not exceed 124 characters)

postalCodestring

House postal code

cupsstring

Deprecated. When filled, CUPS of the supply to connect. This field will be removed in a future version.

Example request

{
  "address": "Leonardo da Vinci 7",
  "postalCode": "41092",
  "cups": "ES0022123456781234AB0F"
}

Response

Created house

idstring

House id

addressstring

House address

postalCodestring

House postal code

Example response

{
  "id": "f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454",
  "address": "Leonardo da Vinci 7",
  "postalCode": "41092"
}

Changes

No recorded changes to this operation across all 1 revision of this API.