Create a form
curl --request POST \
--url https://api.assembly.com/v1/forms \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"additionalFields": {
"formResponseRequests": 12,
"formResponseSubmissions": 8,
"latestSubmissionDate": "2023-11-07T05:31:56Z"
},
"fields": {
"allowMultipleSubmissions": false,
"description": "Tell us about your business so we can tailor onboarding.",
"formFieldIds": [
"q_abc123",
"q_def456"
],
"formFields": [
{
"description": "As it appears on your incorporation documents.",
"formFieldId": "q_abc123",
"hasOtherOption": false,
"isRequired": true,
"multipleChoiceOptions": [
"Option A",
"Option B"
],
"title": "What is your company name?",
"type": "shortAnswer"
}
],
"name": "Client Intake Form",
"visibility": "requestedClients"
}
}
'import requests
url = "https://api.assembly.com/v1/forms"
payload = {
"additionalFields": {
"formResponseRequests": 12,
"formResponseSubmissions": 8,
"latestSubmissionDate": "2023-11-07T05:31:56Z"
},
"fields": {
"allowMultipleSubmissions": False,
"description": "Tell us about your business so we can tailor onboarding.",
"formFieldIds": ["q_abc123", "q_def456"],
"formFields": [
{
"description": "As it appears on your incorporation documents.",
"formFieldId": "q_abc123",
"hasOtherOption": False,
"isRequired": True,
"multipleChoiceOptions": ["Option A", "Option B"],
"title": "What is your company name?",
"type": "shortAnswer"
}
],
"name": "Client Intake Form",
"visibility": "requestedClients"
}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
additionalFields: {
formResponseRequests: 12,
formResponseSubmissions: 8,
latestSubmissionDate: '2023-11-07T05:31:56Z'
},
fields: {
allowMultipleSubmissions: false,
description: 'Tell us about your business so we can tailor onboarding.',
formFieldIds: ['q_abc123', 'q_def456'],
formFields: [
{
description: 'As it appears on your incorporation documents.',
formFieldId: 'q_abc123',
hasOtherOption: false,
isRequired: true,
multipleChoiceOptions: ['Option A', 'Option B'],
title: 'What is your company name?',
type: 'shortAnswer'
}
],
name: 'Client Intake Form',
visibility: 'requestedClients'
}
})
};
fetch('https://api.assembly.com/v1/forms', 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.assembly.com/v1/forms",
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([
'additionalFields' => [
'formResponseRequests' => 12,
'formResponseSubmissions' => 8,
'latestSubmissionDate' => '2023-11-07T05:31:56Z'
],
'fields' => [
'allowMultipleSubmissions' => false,
'description' => 'Tell us about your business so we can tailor onboarding.',
'formFieldIds' => [
'q_abc123',
'q_def456'
],
'formFields' => [
[
'description' => 'As it appears on your incorporation documents.',
'formFieldId' => 'q_abc123',
'hasOtherOption' => false,
'isRequired' => true,
'multipleChoiceOptions' => [
'Option A',
'Option B'
],
'title' => 'What is your company name?',
'type' => 'shortAnswer'
]
],
'name' => 'Client Intake Form',
'visibility' => 'requestedClients'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.assembly.com/v1/forms"
payload := strings.NewReader("{\n \"additionalFields\": {\n \"formResponseRequests\": 12,\n \"formResponseSubmissions\": 8,\n \"latestSubmissionDate\": \"2023-11-07T05:31:56Z\"\n },\n \"fields\": {\n \"allowMultipleSubmissions\": false,\n \"description\": \"Tell us about your business so we can tailor onboarding.\",\n \"formFieldIds\": [\n \"q_abc123\",\n \"q_def456\"\n ],\n \"formFields\": [\n {\n \"description\": \"As it appears on your incorporation documents.\",\n \"formFieldId\": \"q_abc123\",\n \"hasOtherOption\": false,\n \"isRequired\": true,\n \"multipleChoiceOptions\": [\n \"Option A\",\n \"Option B\"\n ],\n \"title\": \"What is your company name?\",\n \"type\": \"shortAnswer\"\n }\n ],\n \"name\": \"Client Intake Form\",\n \"visibility\": \"requestedClients\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.assembly.com/v1/forms")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"additionalFields\": {\n \"formResponseRequests\": 12,\n \"formResponseSubmissions\": 8,\n \"latestSubmissionDate\": \"2023-11-07T05:31:56Z\"\n },\n \"fields\": {\n \"allowMultipleSubmissions\": false,\n \"description\": \"Tell us about your business so we can tailor onboarding.\",\n \"formFieldIds\": [\n \"q_abc123\",\n \"q_def456\"\n ],\n \"formFields\": [\n {\n \"description\": \"As it appears on your incorporation documents.\",\n \"formFieldId\": \"q_abc123\",\n \"hasOtherOption\": false,\n \"isRequired\": true,\n \"multipleChoiceOptions\": [\n \"Option A\",\n \"Option B\"\n ],\n \"title\": \"What is your company name?\",\n \"type\": \"shortAnswer\"\n }\n ],\n \"name\": \"Client Intake Form\",\n \"visibility\": \"requestedClients\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/forms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"additionalFields\": {\n \"formResponseRequests\": 12,\n \"formResponseSubmissions\": 8,\n \"latestSubmissionDate\": \"2023-11-07T05:31:56Z\"\n },\n \"fields\": {\n \"allowMultipleSubmissions\": false,\n \"description\": \"Tell us about your business so we can tailor onboarding.\",\n \"formFieldIds\": [\n \"q_abc123\",\n \"q_def456\"\n ],\n \"formFields\": [\n {\n \"description\": \"As it appears on your incorporation documents.\",\n \"formFieldId\": \"q_abc123\",\n \"hasOtherOption\": false,\n \"isRequired\": true,\n \"multipleChoiceOptions\": [\n \"Option A\",\n \"Option B\"\n ],\n \"title\": \"What is your company name?\",\n \"type\": \"shortAnswer\"\n }\n ],\n \"name\": \"Client Intake Form\",\n \"visibility\": \"requestedClients\"\n }\n}"
response = http.request(request)
puts response.read_body{
"additionalFields": {
"formResponseRequests": 12,
"formResponseSubmissions": 8,
"latestSubmissionDate": "2023-11-07T05:31:56Z"
},
"createdAt": "<string>",
"creatorId": "<string>",
"data": "<string>",
"fields": {
"allowMultipleSubmissions": false,
"description": "Tell us about your business so we can tailor onboarding.",
"formFieldIds": [
"q_abc123",
"q_def456"
],
"formFields": [
{
"description": "As it appears on your incorporation documents.",
"formFieldId": "q_abc123",
"hasOtherOption": false,
"isRequired": true,
"multipleChoiceOptions": [
"Option A",
"Option B"
],
"title": "What is your company name?",
"type": "shortAnswer"
}
],
"name": "Client Intake Form",
"visibility": "requestedClients"
},
"id": "<string>",
"identityId": "<string>",
"object": "<string>",
"owner": {
"id": "<string>",
"metadata": {
"avatarImageUrl": "<string>",
"companyAvatarUrl": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"email": "<string>",
"fallbackColor": "<string>",
"familyName": "<string>",
"givenName": "<string>"
}
},
"previousAttributes": {},
"ref": "<string>",
"updatedAt": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Forms
Create a form
Creates a form with its questions. Note: Assembly forms do not support conditional/branching logic — questions are presented as a flat, ordered sequence.
POST
/
v1
/
forms
Create a form
curl --request POST \
--url https://api.assembly.com/v1/forms \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"additionalFields": {
"formResponseRequests": 12,
"formResponseSubmissions": 8,
"latestSubmissionDate": "2023-11-07T05:31:56Z"
},
"fields": {
"allowMultipleSubmissions": false,
"description": "Tell us about your business so we can tailor onboarding.",
"formFieldIds": [
"q_abc123",
"q_def456"
],
"formFields": [
{
"description": "As it appears on your incorporation documents.",
"formFieldId": "q_abc123",
"hasOtherOption": false,
"isRequired": true,
"multipleChoiceOptions": [
"Option A",
"Option B"
],
"title": "What is your company name?",
"type": "shortAnswer"
}
],
"name": "Client Intake Form",
"visibility": "requestedClients"
}
}
'import requests
url = "https://api.assembly.com/v1/forms"
payload = {
"additionalFields": {
"formResponseRequests": 12,
"formResponseSubmissions": 8,
"latestSubmissionDate": "2023-11-07T05:31:56Z"
},
"fields": {
"allowMultipleSubmissions": False,
"description": "Tell us about your business so we can tailor onboarding.",
"formFieldIds": ["q_abc123", "q_def456"],
"formFields": [
{
"description": "As it appears on your incorporation documents.",
"formFieldId": "q_abc123",
"hasOtherOption": False,
"isRequired": True,
"multipleChoiceOptions": ["Option A", "Option B"],
"title": "What is your company name?",
"type": "shortAnswer"
}
],
"name": "Client Intake Form",
"visibility": "requestedClients"
}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
additionalFields: {
formResponseRequests: 12,
formResponseSubmissions: 8,
latestSubmissionDate: '2023-11-07T05:31:56Z'
},
fields: {
allowMultipleSubmissions: false,
description: 'Tell us about your business so we can tailor onboarding.',
formFieldIds: ['q_abc123', 'q_def456'],
formFields: [
{
description: 'As it appears on your incorporation documents.',
formFieldId: 'q_abc123',
hasOtherOption: false,
isRequired: true,
multipleChoiceOptions: ['Option A', 'Option B'],
title: 'What is your company name?',
type: 'shortAnswer'
}
],
name: 'Client Intake Form',
visibility: 'requestedClients'
}
})
};
fetch('https://api.assembly.com/v1/forms', 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.assembly.com/v1/forms",
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([
'additionalFields' => [
'formResponseRequests' => 12,
'formResponseSubmissions' => 8,
'latestSubmissionDate' => '2023-11-07T05:31:56Z'
],
'fields' => [
'allowMultipleSubmissions' => false,
'description' => 'Tell us about your business so we can tailor onboarding.',
'formFieldIds' => [
'q_abc123',
'q_def456'
],
'formFields' => [
[
'description' => 'As it appears on your incorporation documents.',
'formFieldId' => 'q_abc123',
'hasOtherOption' => false,
'isRequired' => true,
'multipleChoiceOptions' => [
'Option A',
'Option B'
],
'title' => 'What is your company name?',
'type' => 'shortAnswer'
]
],
'name' => 'Client Intake Form',
'visibility' => 'requestedClients'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.assembly.com/v1/forms"
payload := strings.NewReader("{\n \"additionalFields\": {\n \"formResponseRequests\": 12,\n \"formResponseSubmissions\": 8,\n \"latestSubmissionDate\": \"2023-11-07T05:31:56Z\"\n },\n \"fields\": {\n \"allowMultipleSubmissions\": false,\n \"description\": \"Tell us about your business so we can tailor onboarding.\",\n \"formFieldIds\": [\n \"q_abc123\",\n \"q_def456\"\n ],\n \"formFields\": [\n {\n \"description\": \"As it appears on your incorporation documents.\",\n \"formFieldId\": \"q_abc123\",\n \"hasOtherOption\": false,\n \"isRequired\": true,\n \"multipleChoiceOptions\": [\n \"Option A\",\n \"Option B\"\n ],\n \"title\": \"What is your company name?\",\n \"type\": \"shortAnswer\"\n }\n ],\n \"name\": \"Client Intake Form\",\n \"visibility\": \"requestedClients\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.assembly.com/v1/forms")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"additionalFields\": {\n \"formResponseRequests\": 12,\n \"formResponseSubmissions\": 8,\n \"latestSubmissionDate\": \"2023-11-07T05:31:56Z\"\n },\n \"fields\": {\n \"allowMultipleSubmissions\": false,\n \"description\": \"Tell us about your business so we can tailor onboarding.\",\n \"formFieldIds\": [\n \"q_abc123\",\n \"q_def456\"\n ],\n \"formFields\": [\n {\n \"description\": \"As it appears on your incorporation documents.\",\n \"formFieldId\": \"q_abc123\",\n \"hasOtherOption\": false,\n \"isRequired\": true,\n \"multipleChoiceOptions\": [\n \"Option A\",\n \"Option B\"\n ],\n \"title\": \"What is your company name?\",\n \"type\": \"shortAnswer\"\n }\n ],\n \"name\": \"Client Intake Form\",\n \"visibility\": \"requestedClients\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/forms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"additionalFields\": {\n \"formResponseRequests\": 12,\n \"formResponseSubmissions\": 8,\n \"latestSubmissionDate\": \"2023-11-07T05:31:56Z\"\n },\n \"fields\": {\n \"allowMultipleSubmissions\": false,\n \"description\": \"Tell us about your business so we can tailor onboarding.\",\n \"formFieldIds\": [\n \"q_abc123\",\n \"q_def456\"\n ],\n \"formFields\": [\n {\n \"description\": \"As it appears on your incorporation documents.\",\n \"formFieldId\": \"q_abc123\",\n \"hasOtherOption\": false,\n \"isRequired\": true,\n \"multipleChoiceOptions\": [\n \"Option A\",\n \"Option B\"\n ],\n \"title\": \"What is your company name?\",\n \"type\": \"shortAnswer\"\n }\n ],\n \"name\": \"Client Intake Form\",\n \"visibility\": \"requestedClients\"\n }\n}"
response = http.request(request)
puts response.read_body{
"additionalFields": {
"formResponseRequests": 12,
"formResponseSubmissions": 8,
"latestSubmissionDate": "2023-11-07T05:31:56Z"
},
"createdAt": "<string>",
"creatorId": "<string>",
"data": "<string>",
"fields": {
"allowMultipleSubmissions": false,
"description": "Tell us about your business so we can tailor onboarding.",
"formFieldIds": [
"q_abc123",
"q_def456"
],
"formFields": [
{
"description": "As it appears on your incorporation documents.",
"formFieldId": "q_abc123",
"hasOtherOption": false,
"isRequired": true,
"multipleChoiceOptions": [
"Option A",
"Option B"
],
"title": "What is your company name?",
"type": "shortAnswer"
}
],
"name": "Client Intake Form",
"visibility": "requestedClients"
},
"id": "<string>",
"identityId": "<string>",
"object": "<string>",
"owner": {
"id": "<string>",
"metadata": {
"avatarImageUrl": "<string>",
"companyAvatarUrl": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"email": "<string>",
"fallbackColor": "<string>",
"familyName": "<string>",
"givenName": "<string>"
}
},
"previousAttributes": {},
"ref": "<string>",
"updatedAt": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Authorizations
Body
application/json
Form to create
⌘I