Create session form

Create a form for a session.

POST /api/session/{sessionID}/form

Create session form

cURL

curl --request POST \
  --url https://api.example.com/api/session/{sessionID}/form \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "id": "<string>",
  "metadata": {},
  "fields": [
    {
      "key": "<string>",
      "type": "string",
      "title": "<string>",
      "description": "<string>",
      "required": true,
      "when": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "minLength": 1,
      "maxLength": 1,
      "pattern": "<string>",
      "placeholder": "<string>",
      "default": "<string>",
      "options": [
        {
          "value": "<string>",
          "label": "<string>",
          "description": "<string>"
        }
      ],
      "custom": true
    }
  ],
  "url": "<string>"
}
'

import requests

url = "https://api.example.com/api/session/{sessionID}/form"

payload = {
    "title": "<string>",
    "id": "<string>",
    "metadata": {},
    "fields": [
        {
            "key": "<string>",
            "type": "string",
            "title": "<string>",
            "description": "<string>",
            "required": True,
            "when": [
                {
                    "key": "<string>",
                    "value": "<string>"
                }
            ],
            "minLength": 1,
            "maxLength": 1,
            "pattern": "<string>",
            "placeholder": "<string>",
            "default": "<string>",
            "options": [
                {
                    "value": "<string>",
                    "label": "<string>",
                    "description": "<string>"
                }
            ],
            "custom": True
        }
    ],
    "url": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    id: '<string>',
    metadata: {},
    fields: [
      {
        key: '<string>',
        type: 'string',
        title: '<string>',
        description: '<string>',
        required: true,
        when: [{key: '<string>', value: '<string>'}],
        minLength: 1,
        maxLength: 1,
        pattern: '<string>',
        placeholder: '<string>',
        default: '<string>',
        options: [{value: '<string>', label: '<string>', description: '<string>'}],
        custom: true
      }
    ],
    url: '<string>'
  })
};

fetch('https://api.example.com/api/session/{sessionID}/form', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/session/{sessionID}/form",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'id' => '<string>',
    'metadata' => [
        
    ],
    'fields' => [
        [
                'key' => '<string>',
                'type' => 'string',
                'title' => '<string>',
                'description' => '<string>',
                'required' => true,
                'when' => [
                                [
                                                                'key' => '<string>',
                                                                'value' => '<string>'
                                ]
                ],
                'minLength' => 1,
                'maxLength' => 1,
                'pattern' => '<string>',
                'placeholder' => '<string>',
                'default' => '<string>',
                'options' => [
                                [
                                                                'value' => '<string>',
                                                                'label' => '<string>',
                                                                'description' => '<string>'
                                ]
                ],
                'custom' => true
        ]
    ],
    'url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/session/{sessionID}/form"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"id\": \"<string>\",\n  \"metadata\": {},\n  \"fields\": [\n    {\n      \"key\": \"<string>\",\n      \"type\": \"string\",\n      \"title\": \"<string>\",\n      \"description\": \"<string>\",\n      \"required\": true,\n      \"when\": [\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"minLength\": 1,\n      \"maxLength\": 1,\n      \"pattern\": \"<string>\",\n      \"placeholder\": \"<string>\",\n      \"default\": \"<string>\",\n      \"options\": [\n        {\n          \"value\": \"<string>\",\n          \"label\": \"<string>\",\n          \"description\": \"<string>\"\n        }\n      ],\n      \"custom\": true\n    }\n  ],\n  \"url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/session/{sessionID}/form")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"id\": \"<string>\",\n  \"metadata\": {},\n  \"fields\": [\n    {\n      \"key\": \"<string>\",\n      \"type\": \"string\",\n      \"title\": \"<string>\",\n      \"description\": \"<string>\",\n      \"required\": true,\n      \"when\": [\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"minLength\": 1,\n      \"maxLength\": 1,\n      \"pattern\": \"<string>\",\n      \"placeholder\": \"<string>\",\n      \"default\": \"<string>\",\n      \"options\": [\n        {\n          \"value\": \"<string>\",\n          \"label\": \"<string>\",\n          \"description\": \"<string>\"\n        }\n      ],\n      \"custom\": true\n    }\n  ],\n  \"url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/session/{sessionID}/form")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"id\": \"<string>\",\n  \"metadata\": {},\n  \"fields\": [\n    {\n      \"key\": \"<string>\",\n      \"type\": \"string\",\n      \"title\": \"<string>\",\n      \"description\": \"<string>\",\n      \"required\": true,\n      \"when\": [\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"minLength\": 1,\n      \"maxLength\": 1,\n      \"pattern\": \"<string>\",\n      \"placeholder\": \"<string>\",\n      \"default\": \"<string>\",\n      \"options\": [\n        {\n          \"value\": \"<string>\",\n          \"label\": \"<string>\",\n          \"description\": \"<string>\"\n        }\n      ],\n      \"custom\": true\n    }\n  ],\n  \"url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "id": "<string>",
    "sessionID": "<string>",
    "title": "<string>",
    "mode": "form",
    "fields": [
      {
        "key": "<string>",
        "type": "string",
        "title": "<string>",
        "description": "<string>",
        "required": true,
        "when": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ],
        "minLength": 1,
        "maxLength": 1,
        "pattern": "<string>",
        "placeholder": "<string>",
        "default": "<string>",
        "options": [
          {
            "value": "<string>",
            "label": "<string>",
            "description": "<string>"
          }
        ],
        "custom": true
      }
    ],
    "metadata": {}
  }
}

{
  "_tag": "InvalidRequestError",
  "message": "<string>",
  "kind": "<string>",
  "field": "<string>"
}

{
  "_tag": "UnauthorizedError",
  "message": "<string>"
}

{
  "_tag": "SessionNotFoundError",
  "sessionID": "<string>",
  "message": "<string>"
}

{
  "_tag": "ConflictError",
  "message": "<string>",
  "resource": "<string>"
}

Path Parameters

sessionID · string · required

Body

application/json

title · string · required

mode · enum<string> · required

Available options: form, url

id · string | null

Pattern: ^frm_

metadata · object

fields · object[] | null

Option 1

Option 2

Option 3

Option 4

Option 5

Show child attributes

url · string | null

Response

200

application/json

Success

data · object · required

Option 1

Option 2

Show child attributes