cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/settings/custom_forms" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"custom_form": {
"name": "acme-account-form",
"setting_group": "ACCOUNT"
}
}'from exsited import build_client
client = build_client()
response = client.custom_forms.create_settings_custom_form(
{"custom_form": {"name": "acme-account-form", "setting_group": "ACCOUNT"}}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.customForms.createSettingsCustomForm({
custom_form: {name: 'acme-account-form', setting_group: 'ACCOUNT'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->customForms->createSettingsCustomForm([
'custom_form' => ['name' => 'acme-account-form', 'setting_group' => 'ACCOUNT'],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.custom_forms.custom_forms_dto.CustomFormsDto.SettingsCustomForm;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<SettingsCustomForm> response = client.customForms().createSettingsCustomForm(
Map.of("custom_form", Map.of("name", "acme-account-form", "setting_group", "ACCOUNT")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.CustomForms.CreateSettingsCustomFormAsync(new Dictionary<string, object?>
{
["custom_form"] = new Dictionary<string, object?>
{
["name"] = "acme-account-form",
["setting_group"] = "ACCOUNT",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.customForms.createSettingsCustomForm({
'custom_form': {'name': 'acme-account-form', 'setting_group': 'ACCOUNT'},
});
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.CustomForms().CreateSettingsCustomForm(context.Background(), map[string]any{
"custom_form": map[string]any{
"name": "acme-account-form",
"setting_group": "ACCOUNT",
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"custom_form": {
"object": "<string>",
"id": "<string>",
"status": "<string>",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"is_system_template": true,
"for_default_template": true,
"created_on": "<string>",
"last_updated_on": "<string>",
"created_by": "<unknown>",
"last_updated_by": "<unknown>",
"href": "<string>"
}
}Custom forms
Create a custom form
Creates a custom form and returns it, under custom_form.
POST
/
settings
/
custom_forms
cURL
curl -X POST "$EXSITED_BASE_URL/api/v4/settings/custom_forms" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"custom_form": {
"name": "acme-account-form",
"setting_group": "ACCOUNT"
}
}'from exsited import build_client
client = build_client()
response = client.custom_forms.create_settings_custom_form(
{"custom_form": {"name": "acme-account-form", "setting_group": "ACCOUNT"}}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.customForms.createSettingsCustomForm({
custom_form: {name: 'acme-account-form', setting_group: 'ACCOUNT'},
});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->customForms->createSettingsCustomForm([
'custom_form' => ['name' => 'acme-account-form', 'setting_group' => 'ACCOUNT'],
]);
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.custom_forms.custom_forms_dto.CustomFormsDto.SettingsCustomForm;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<SettingsCustomForm> response = client.customForms().createSettingsCustomForm(
Map.of("custom_form", Map.of("name", "acme-account-form", "setting_group", "ACCOUNT")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.CustomForms.CreateSettingsCustomFormAsync(new Dictionary<string, object?>
{
["custom_form"] = new Dictionary<string, object?>
{
["name"] = "acme-account-form",
["setting_group"] = "ACCOUNT",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.customForms.createSettingsCustomForm({
'custom_form': {'name': 'acme-account-form', 'setting_group': 'ACCOUNT'},
});
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.CustomForms().CreateSettingsCustomForm(context.Background(), map[string]any{
"custom_form": map[string]any{
"name": "acme-account-form",
"setting_group": "ACCOUNT",
},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"custom_form": {
"object": "<string>",
"id": "<string>",
"status": "<string>",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"is_system_template": true,
"for_default_template": true,
"created_on": "<string>",
"last_updated_on": "<string>",
"created_by": "<unknown>",
"last_updated_by": "<unknown>",
"href": "<string>"
}
}Creates a new custom form. Send
name and setting_group, a setting group name such as ACCOUNT, under custom_form. The new form comes back with its cf_ id.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Body
application/json
Show child attributes
Show child attributes
Response
201 - application/json
The new custom form, under custom_form.
Show child attributes
Show child attributes