Skip to content

Create Form Group

POST
/forms/groups

Treat several inventory rows as one form.

A member already in another group is MOVED here, not copied.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors CuratedGroupCreateRequest. Members already in another group are MOVED here.

object
form_type
Any of:
string
Allowed values: lead newsletter meeting contact download other
members
Array<object>
<= 200 items

One inventory row in a curated group. Mirrors GroupMemberRefRequest.

object
form_key
required
string
>= 1 characters <= 500 characters
source_id
required

Write key, or its bare key id.

string
>= 1 characters <= 500 characters
name
required
string
>= 1 characters <= 200 characters

Responses

201

Successful Response

object
data
required

One forms object, or one handler response.

Open-shaped: the submission, mapping, group and audit payloads grow with the product, and a closed model here would silently drop what it does not name.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string