Skip to main content
POST
Create or replace a form

Authorizations

Authorization
string
header
required

A workspace API key: wdy_live_… / wdy_test_…. Created at POST /workspaces/{tenantId}/keys and shown exactly once.

Body

application/json
key
string
required

The kebab-case id the model emits.

description
string
required

When to offer the form. English unless descriptionLocale is supplied.

Maximum string length: 600
fields
object[]
required
Maximum array length: 8
submit
object
required
successMessage
object
required
name
string

Administrative name. Omission preserves the existing name.

Maximum string length: 120
agentId
object | null

The agent this form belongs to; null = the workspace pool.

descriptionLocale
enum<string>

Language of the supplied instructions. Omit for legacy English.

Available options:
es,
en

A link id from the agent, where success navigates.

notifyOwners
boolean

Response

id
string
required
agentId
object | null
required
key
string
required
description
string
required
descriptionText
object
required
fields
object[]
required
submit
object
required
successMessage
object
required
notifyOwners
boolean
required
createdAt
string
required
updatedAt
string
required
name
string
Maximum string length: 120