Template Edit

PUT user-settings/templates/<template_id>

Edit the template specified in the request path with the body sent.

Request

Example request

curl -X PUT 'https://api.pricehubble.com/api/v1/user-settings/templates/e1bb921e-7d77-4914-84b3-1529b22842e8' \
  -H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "My template",
    "countryCode": "CH",
    "level": "user",
    "rentType": "rent_net",
    "frontCover": true,
    "backCover": false,
    "sections": [
      {
        "type": "overview",
        "enabled": true,
        "configuration": {
            "layout": "brochure"
        }
      },
      {
        "type": "comparables",
        "enabled": true,
        "configuration": {
            "offers": true,
            "transactions": true,
            "market_trends": true,
            "offer_details": true,
            "transaction_details": true
        }
      },
      {
        "type": "market",
        "enabled": true,
        "configuration": {}
      },
      {
        "type": "socio",
        "enabled": true,
        "configuration": {
            "economics": true,
            "demographics": true
        }
      },
      {
        "type": "environment",
        "enabled": true,
        "configuration": {
            "view": true,
            "noise": true,
            "nuisance": true
        }
      },
      {
        "type": "amenities",
        "enabled": true,
        "configuration": {
            "health": true,
            "leisure": true,
            "catering": true,
            "shopping": true,
            "education": true
        }
      },
      {
        "type": "accessibility",
        "enabled": true,
        "configuration": {}
      },
      {
        "type": "projects",
        "enabled": true,
        "configuration": {}
      },
      {
        "type": "attachments.floorplan",
        "enabled": true,
        "configuration": {}
      },
      {
        "type": "attachments.permit",
        "enabled": true,
        "configuration": {}
      },
      {
        "type": "attachments.marketing",
        "enabled": true,
        "configuration": {}
      },
      {
        "type": "attachments.valuation",
        "enabled": true,
        "configuration": {}
      },
      {
        "type": "attachments.other",
        "enabled": true,
        "configuration": {}
      }
    ]
  }'

Response

Field	Description	Type	Remarks
title	The title of the template	string
level	The visibility level of the template	string	user or organization, needs to be the same as the original template, the level of a template can't be changed.
countryCode	ISO country code	string	This field can't be changed.
rentType	Rent type to use if the PDF printed contains rent valuations	string	rent_net or rent_gross.
frontCover	Whether to display a front cover or not	boolean
backCover	Whether to display a back cover or not	boolean
sections	Order and visibility of sections	Array of Sections