API

2 min

Create form link

https://vdobrenko.hyper1.net/swagger/#tag/Forms/paths/~1forms~1{formId}/post

Get public form by id

Data schema for rendering the form to the user

GET

https://{{vladislavk}}/v2-forms/public/{{lUBsYNOIQOgnqWiUDoYOJ}}

Path Parameters

formIdstring

Query Parameters

tstring
Description
Token defining the context of the form

javascript

fetch("https://hypercharge.hyper1.net/v2-forms/public/formsUnsubscribe", {
  "method": "GET",
  "headers": {
    "Accept": "application/json"
  }
})
.then(response => {
  console.log(response);
})
.catch(err => {
  console.error(err);
});

200

{
    "form": {
        "ui": {},
        "data": {},
        "schema": {
            "type": "object",
            "title": "Unsubscribe form",
            "required": [
                "mailSubscription"
            ],
            "properties": {
                "mailSubscription": {
                    "type": "boolean",
                    "title": "Unsubscribe?",
                    "default": true
                }
            },
            "description": "Hi Customer. On this form you can unsubscribe from the newsletter [email protected]"
        }
    },
    "logo": "https://hypercharge.hyper1.net/assets/images/logo.jpg",
    "description": "Brusselsesteenweg 506, 9050 Gent-Ledeberg\[email protected]\nCIAC VAT: 0460.935.684"
}

404

Save public form

The entity item will be added to the entity that is configured in the administrative panel of the portal

POST

https://{{host}}/v2-forms/public/{{formId}}

Path Parameters

formIdstring

Query Parameters

tstring
Description
Token defining the context of the form

Body Parameters

propertyId1string
Description
Property id which will be saved in form entity item
propertyIdNstring
Description
Property id which will be saved in form entity item
g-recaptcha-responsestring
Description
Response from google reCAPTCHA to remove the ban

javascript

fetch("https://hypercharge.hyper1.net/v2-forms/public/formsUnsubscribe", {
  "method": "POST",
  "headers": {
    "Accept": "application/json"
  },
  "body": JSON.stringify(data)
})
.then(response => {
  console.log(response);
})
.catch(err => {
  console.error(err);
});

200

{
    "status": "success"
}

404

429

{
    "code": "TOO_MANY_REQUESTS"
}