---
title: API
slug: hyper-portal/api
docTags: 
createdAt: 2021-05-06T08:37:37.000Z
---



### Create form link

[https://vdobrenko.hyper1.net/swagger/#tag/Forms/paths/\~1forms\~1{formId}/post](https://vdobrenko.hyper1.net/swagger/#tag/Forms/paths/~1forms~1\{formId}/post)



:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "https://{{vladislavk}}/v2-forms/public/{{lUBsYNOIQOgnqWiUDoYOJ}}",
  "name": "Get public form by id",
  "method": "GET",
  "request": {
    "pathParameters": [
      {
        "kind": "optional",
        "name": "formId",
        "type": "string",
        "description": ""
      }
    ],
    "queryParameters": [
      {
        "kind": "optional",
        "name": "t",
        "type": "string",
        "description": "Token defining the context of the form"
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "1S_tpHNM2dHKJTghUHsE6",
        "code": "{\n    \"form\": {\n        \"ui\": {},\n        \"data\": {},\n        \"schema\": {\n            \"type\": \"object\",\n            \"title\": \"Unsubscribe form\",\n            \"required\": [\n                \"mailSubscription\"\n            ],\n            \"properties\": {\n                \"mailSubscription\": {\n                    \"type\": \"boolean\",\n                    \"title\": \"Unsubscribe?\",\n                    \"default\": true\n                }\n            },\n            \"description\": \"Hi Customer. On this form you can unsubscribe from the newsletter customer@hypercharge.io\"\n        }\n    },\n    \"logo\": \"https://hypercharge.hyper1.net/assets/images/logo.jpg\",\n    \"description\": \"Brusselsesteenweg 506, 9050 Gent-Ledeberg\\ninfo@ciac.be\\nCIAC VAT: 0460.935.684\"\n}",
        "language": "200"
      },
      {
        "id": "PohZB74A2mCslD8cn4c-G",
        "code": "",
        "language": "404"
      }
    ],
    "selectedLanguageId": "1S_tpHNM2dHKJTghUHsE6"
  },
  "examples": {
    "languages": [
      {
        "id": "PKll4QxU8HHh92QTHJt-Z",
        "code": "fetch(\"https://hypercharge.hyper1.net/v2-forms/public/formsUnsubscribe\", {\n  \"method\": \"GET\",\n  \"headers\": {\n    \"Accept\": \"application/json\"\n  }\n})\n.then(response => {\n  console.log(response);\n})\n.catch(err => {\n  console.error(err);\n});",
        "language": "javascript"
      }
    ],
    "selectedLanguageId": "PKll4QxU8HHh92QTHJt-Z"
  },
  "description": "Data schema for rendering the form to the user",
  "currentNewParameter": {
    "label": "Path Parameter",
    "value": "pathParameters"
  },
  "hasTryItOut": false,
  "autoGeneratedAnchorSlug": "get-public-form-by-id",
  "legacyHash": "-wfDxzJ_eLF1XQgKSI-MW"
}
```
:::



:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "https://{{host}}/v2-forms/public/{{formId}}",
  "name": "Save public form",
  "method": "POST",
  "request": {
    "pathParameters": [
      {
        "kind": "optional",
        "name": "formId",
        "type": "string",
        "description": ""
      }
    ],
    "queryParameters": [
      {
        "kind": "optional",
        "name": "t",
        "type": "string",
        "description": "Token defining the context of the form"
      }
    ],
    "headerParameters": [],
    "bodyDataParameters": [
      {
        "kind": "optional",
        "name": "propertyId1",
        "type": "string",
        "description": "Property id which will be saved in form entity item"
      },
      {
        "kind": "optional",
        "name": "propertyIdN",
        "type": "string",
        "description": "Property id which will be saved in form entity item"
      },
      {
        "kind": "optional",
        "name": "g-recaptcha-response",
        "type": "string",
        "description": "Response from google reCAPTCHA to remove the ban"
      }
    ],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "kvpmNjEsYZVlrzuR6wEma",
        "code": "{\n    \"status\": \"success\"\n}",
        "language": "200"
      },
      {
        "id": "w6geWd5YqVKj1V0WKUMsR",
        "code": "",
        "language": "404"
      },
      {
        "id": "QuXMpwQG_t62Ilv8ZWchj",
        "code": "{\n    \"code\": \"TOO_MANY_REQUESTS\"\n}",
        "language": "429"
      }
    ],
    "selectedLanguageId": "kvpmNjEsYZVlrzuR6wEma"
  },
  "examples": {
    "languages": [
      {
        "id": "_I5jdj-txcDNsa8ycd2xI",
        "code": "fetch(\"https://hypercharge.hyper1.net/v2-forms/public/formsUnsubscribe\", {\n  \"method\": \"POST\",\n  \"headers\": {\n    \"Accept\": \"application/json\"\n  },\n  \"body\": JSON.stringify(data)\n})\n.then(response => {\n  console.log(response);\n})\n.catch(err => {\n  console.error(err);\n});",
        "language": "javascript"
      }
    ],
    "selectedLanguageId": "_I5jdj-txcDNsa8ycd2xI"
  },
  "description": "The entity item will be added to the entity that is configured in the administrative panel of the portal",
  "currentNewParameter": {
    "label": "Path Parameter",
    "value": "pathParameters"
  },
  "hasTryItOut": false,
  "autoGeneratedAnchorSlug": "save-public-form",
  "legacyHash": "673UNDDbme45ftBR0rhPa"
}
```
:::