Assign a form to clients
curl --request POST \
--url https://api.assembly.com/v1/form-responses \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"formId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"clientCompanyIds": [
{
"clientId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"companyId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"clientIds": [
"a1b2c3d4-5678-90ab-cdef-1234567890ab"
]
}
'import requests
url = "https://api.assembly.com/v1/form-responses"
payload = {
"formId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"clientCompanyIds": [
{
"clientId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"companyId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"clientIds": ["a1b2c3d4-5678-90ab-cdef-1234567890ab"]
}
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({
formId: 'd290f1ee-6c54-4b01-90e6-d701748f0851',
clientCompanyIds: [
{
clientId: 'a1b2c3d4-5678-90ab-cdef-1234567890ab',
companyId: 'f47ac10b-58cc-4372-a567-0e02b2c3d479'
}
],
clientIds: ['a1b2c3d4-5678-90ab-cdef-1234567890ab']
})
};
fetch('https://api.assembly.com/v1/form-responses', 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/form-responses",
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([
'formId' => 'd290f1ee-6c54-4b01-90e6-d701748f0851',
'clientCompanyIds' => [
[
'clientId' => 'a1b2c3d4-5678-90ab-cdef-1234567890ab',
'companyId' => 'f47ac10b-58cc-4372-a567-0e02b2c3d479'
]
],
'clientIds' => [
'a1b2c3d4-5678-90ab-cdef-1234567890ab'
]
]),
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/form-responses"
payload := strings.NewReader("{\n \"formId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\",\n \"clientCompanyIds\": [\n {\n \"clientId\": \"a1b2c3d4-5678-90ab-cdef-1234567890ab\",\n \"companyId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n }\n ],\n \"clientIds\": [\n \"a1b2c3d4-5678-90ab-cdef-1234567890ab\"\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/form-responses")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"formId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\",\n \"clientCompanyIds\": [\n {\n \"clientId\": \"a1b2c3d4-5678-90ab-cdef-1234567890ab\",\n \"companyId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n }\n ],\n \"clientIds\": [\n \"a1b2c3d4-5678-90ab-cdef-1234567890ab\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/form-responses")
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 \"formId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\",\n \"clientCompanyIds\": [\n {\n \"clientId\": \"a1b2c3d4-5678-90ab-cdef-1234567890ab\",\n \"companyId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n }\n ],\n \"clientIds\": [\n \"a1b2c3d4-5678-90ab-cdef-1234567890ab\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"clientId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"companyId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"createdAt": "<string>",
"creatorId": "<string>",
"data": "<string>",
"fields": {
"allowMultipleSubmissions": false,
"formDescription": "Tell us about your business so we can tailor onboarding.",
"formFieldIds": [
"q_abc123",
"q_def456"
],
"formFields": {},
"formName": "Client Intake Form",
"status": "pending",
"submissionDate": "2023-11-07T05:31:56Z",
"visibility": "requestedClients"
},
"filteredListIndexPkey": "<string>",
"formId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"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>"
}
],
"nextToken": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Form Responses
Assign a form to clients
Assigns a form to one or more clients, creating a pending form response for each recipient. Provide either clientIds or clientCompanyIds.
POST
/
v1
/
form-responses
Assign a form to clients
curl --request POST \
--url https://api.assembly.com/v1/form-responses \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"formId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"clientCompanyIds": [
{
"clientId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"companyId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"clientIds": [
"a1b2c3d4-5678-90ab-cdef-1234567890ab"
]
}
'import requests
url = "https://api.assembly.com/v1/form-responses"
payload = {
"formId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"clientCompanyIds": [
{
"clientId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"companyId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
],
"clientIds": ["a1b2c3d4-5678-90ab-cdef-1234567890ab"]
}
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({
formId: 'd290f1ee-6c54-4b01-90e6-d701748f0851',
clientCompanyIds: [
{
clientId: 'a1b2c3d4-5678-90ab-cdef-1234567890ab',
companyId: 'f47ac10b-58cc-4372-a567-0e02b2c3d479'
}
],
clientIds: ['a1b2c3d4-5678-90ab-cdef-1234567890ab']
})
};
fetch('https://api.assembly.com/v1/form-responses', 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/form-responses",
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([
'formId' => 'd290f1ee-6c54-4b01-90e6-d701748f0851',
'clientCompanyIds' => [
[
'clientId' => 'a1b2c3d4-5678-90ab-cdef-1234567890ab',
'companyId' => 'f47ac10b-58cc-4372-a567-0e02b2c3d479'
]
],
'clientIds' => [
'a1b2c3d4-5678-90ab-cdef-1234567890ab'
]
]),
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/form-responses"
payload := strings.NewReader("{\n \"formId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\",\n \"clientCompanyIds\": [\n {\n \"clientId\": \"a1b2c3d4-5678-90ab-cdef-1234567890ab\",\n \"companyId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n }\n ],\n \"clientIds\": [\n \"a1b2c3d4-5678-90ab-cdef-1234567890ab\"\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/form-responses")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"formId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\",\n \"clientCompanyIds\": [\n {\n \"clientId\": \"a1b2c3d4-5678-90ab-cdef-1234567890ab\",\n \"companyId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n }\n ],\n \"clientIds\": [\n \"a1b2c3d4-5678-90ab-cdef-1234567890ab\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.assembly.com/v1/form-responses")
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 \"formId\": \"d290f1ee-6c54-4b01-90e6-d701748f0851\",\n \"clientCompanyIds\": [\n {\n \"clientId\": \"a1b2c3d4-5678-90ab-cdef-1234567890ab\",\n \"companyId\": \"f47ac10b-58cc-4372-a567-0e02b2c3d479\"\n }\n ],\n \"clientIds\": [\n \"a1b2c3d4-5678-90ab-cdef-1234567890ab\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"clientId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"companyId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"createdAt": "<string>",
"creatorId": "<string>",
"data": "<string>",
"fields": {
"allowMultipleSubmissions": false,
"formDescription": "Tell us about your business so we can tailor onboarding.",
"formFieldIds": [
"q_abc123",
"q_def456"
],
"formFields": {},
"formName": "Client Intake Form",
"status": "pending",
"submissionDate": "2023-11-07T05:31:56Z",
"visibility": "requestedClients"
},
"filteredListIndexPkey": "<string>",
"formId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"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>"
}
],
"nextToken": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}{
"code": "<string>",
"data": "<unknown>",
"message": "<string>"
}Authorizations
Body
application/json
Form assignment request
ID of the form to assign.
Example:
"d290f1ee-6c54-4b01-90e6-d701748f0851"
Client/company pairs to assign the form to. Required when clientIds is omitted.
Show child attributes
Show child attributes
Client IDs to assign the form to. Required when clientCompanyIds is omitted.
Example:
["a1b2c3d4-5678-90ab-cdef-1234567890ab"]
⌘I