Create a topic form
Creates a signup form for the visible topic and returns 201.
POST
Creates a signup form for the visible topic and returns 201. The server generates its opaque public key. allowedOrigins contains exact HTTPS origins; the canonical web origin and current topic link origin are also accepted. Copy is plain text and redirectUrl is HTTPS or null.
apiKeyheader
x-api-key<token>id*stringMatch
^tpc_[0-9a-hjkmnp-tv-z]{16,24}$application/json- body
allowedOrigins*array<>Items
items <= 20confirmationTitle*stringLength
1 <= length <= 120confirmationMessage*stringLength
1 <= length <= 2000successTitle*stringLength
1 <= length <= 120successMessage*stringLength
1 <= length <= 2000redirectUrl*|nullTopicForm
application/json- response
id*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$Format
uuidpublicKey*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$Format
uuidtopicId*TopicIdMatch
^tpc_[0-9a-hjkmnp-tv-z]{16,24}$allowedOrigins*array<>Items
items <= 20confirmationTitle*stringLength
1 <= length <= 120confirmationMessage*stringLength
1 <= length <= 2000successTitle*stringLength
1 <= length <= 120successMessage*stringLength
1 <= length <= 2000redirectUrl*|nulllinkOrigin*stringcreatedAt*stringupdatedAt*stringimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.topicForms.create({
"id": "example",
"allowedOrigins": [
"example"
],
"confirmationTitle": "example",
"confirmationMessage": "example",
"successTitle": "example",
"successMessage": "example",
"redirectUrl": "example"
});Example Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"publicKey": "29f62ed2-b67a-44ba-84f5-217ecee94438",
"topicId": "string",
"allowedOrigins": [
"string"
],
"confirmationTitle": "string",
"confirmationMessage": "string",
"successTitle": "string",
"successMessage": "string",
"redirectUrl": "string",
"linkOrigin": "string",
"createdAt": "string",
"updatedAt": "string"
}