Upload Bulk Contacts
curl --request PUT \
--url https://app.formbricks.com/api/v2/management/contacts/bulk \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"workspaceId": "ws_01h2xce9q8p3w4x5y6z7a8b9c0",
"contacts": [
{
"attributes": [
{
"attributeKey": {
"key": "email",
"name": "Email Address"
},
"value": "[email protected]"
},
{
"attributeKey": {
"key": "firstName",
"name": "First Name"
},
"value": "John"
},
{
"attributeKey": {
"key": "lastName",
"name": "Last Name"
},
"value": "Doe"
}
]
},
{
"attributes": [
{
"attributeKey": {
"key": "email",
"name": "Email Address"
},
"value": "[email protected]"
},
{
"attributeKey": {
"key": "firstName",
"name": "First Name"
},
"value": "Jane"
},
{
"attributeKey": {
"key": "lastName",
"name": "Last Name"
},
"value": "Smith"
}
]
}
]
}
'import requests
url = "https://app.formbricks.com/api/v2/management/contacts/bulk"
payload = {
"workspaceId": "ws_01h2xce9q8p3w4x5y6z7a8b9c0",
"contacts": [{ "attributes": [
{
"attributeKey": {
"key": "email",
"name": "Email Address"
},
"value": "[email protected]"
},
{
"attributeKey": {
"key": "firstName",
"name": "First Name"
},
"value": "John"
},
{
"attributeKey": {
"key": "lastName",
"name": "Last Name"
},
"value": "Doe"
}
] }, { "attributes": [
{
"attributeKey": {
"key": "email",
"name": "Email Address"
},
"value": "[email protected]"
},
{
"attributeKey": {
"key": "firstName",
"name": "First Name"
},
"value": "Jane"
},
{
"attributeKey": {
"key": "lastName",
"name": "Last Name"
},
"value": "Smith"
}
] }]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaceId: 'ws_01h2xce9q8p3w4x5y6z7a8b9c0',
contacts: [
{
attributes: [
{
attributeKey: {key: 'email', name: 'Email Address'},
value: '[email protected]'
},
{attributeKey: {key: 'firstName', name: 'First Name'}, value: 'John'},
{attributeKey: {key: 'lastName', name: 'Last Name'}, value: 'Doe'}
]
},
{
attributes: [
{
attributeKey: {key: 'email', name: 'Email Address'},
value: '[email protected]'
},
{attributeKey: {key: 'firstName', name: 'First Name'}, value: 'Jane'},
{attributeKey: {key: 'lastName', name: 'Last Name'}, value: 'Smith'}
]
}
]
})
};
fetch('https://app.formbricks.com/api/v2/management/contacts/bulk', 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://app.formbricks.com/api/v2/management/contacts/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'workspaceId' => 'ws_01h2xce9q8p3w4x5y6z7a8b9c0',
'contacts' => [
[
'attributes' => [
[
'attributeKey' => [
'key' => 'email',
'name' => 'Email Address'
],
'value' => '[email protected]'
],
[
'attributeKey' => [
'key' => 'firstName',
'name' => 'First Name'
],
'value' => 'John'
],
[
'attributeKey' => [
'key' => 'lastName',
'name' => 'Last Name'
],
'value' => 'Doe'
]
]
],
[
'attributes' => [
[
'attributeKey' => [
'key' => 'email',
'name' => 'Email Address'
],
'value' => '[email protected]'
],
[
'attributeKey' => [
'key' => 'firstName',
'name' => 'First Name'
],
'value' => 'Jane'
],
[
'attributeKey' => [
'key' => 'lastName',
'name' => 'Last Name'
],
'value' => 'Smith'
]
]
]
]
]),
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://app.formbricks.com/api/v2/management/contacts/bulk"
payload := strings.NewReader("{\n \"workspaceId\": \"ws_01h2xce9q8p3w4x5y6z7a8b9c0\",\n \"contacts\": [\n {\n \"attributes\": [\n {\n \"attributeKey\": {\n \"key\": \"email\",\n \"name\": \"Email Address\"\n },\n \"value\": \"[email protected]\"\n },\n {\n \"attributeKey\": {\n \"key\": \"firstName\",\n \"name\": \"First Name\"\n },\n \"value\": \"John\"\n },\n {\n \"attributeKey\": {\n \"key\": \"lastName\",\n \"name\": \"Last Name\"\n },\n \"value\": \"Doe\"\n }\n ]\n },\n {\n \"attributes\": [\n {\n \"attributeKey\": {\n \"key\": \"email\",\n \"name\": \"Email Address\"\n },\n \"value\": \"[email protected]\"\n },\n {\n \"attributeKey\": {\n \"key\": \"firstName\",\n \"name\": \"First Name\"\n },\n \"value\": \"Jane\"\n },\n {\n \"attributeKey\": {\n \"key\": \"lastName\",\n \"name\": \"Last Name\"\n },\n \"value\": \"Smith\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.formbricks.com/api/v2/management/contacts/bulk")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"ws_01h2xce9q8p3w4x5y6z7a8b9c0\",\n \"contacts\": [\n {\n \"attributes\": [\n {\n \"attributeKey\": {\n \"key\": \"email\",\n \"name\": \"Email Address\"\n },\n \"value\": \"[email protected]\"\n },\n {\n \"attributeKey\": {\n \"key\": \"firstName\",\n \"name\": \"First Name\"\n },\n \"value\": \"John\"\n },\n {\n \"attributeKey\": {\n \"key\": \"lastName\",\n \"name\": \"Last Name\"\n },\n \"value\": \"Doe\"\n }\n ]\n },\n {\n \"attributes\": [\n {\n \"attributeKey\": {\n \"key\": \"email\",\n \"name\": \"Email Address\"\n },\n \"value\": \"[email protected]\"\n },\n {\n \"attributeKey\": {\n \"key\": \"firstName\",\n \"name\": \"First Name\"\n },\n \"value\": \"Jane\"\n },\n {\n \"attributeKey\": {\n \"key\": \"lastName\",\n \"name\": \"Last Name\"\n },\n \"value\": \"Smith\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v2/management/contacts/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"ws_01h2xce9q8p3w4x5y6z7a8b9c0\",\n \"contacts\": [\n {\n \"attributes\": [\n {\n \"attributeKey\": {\n \"key\": \"email\",\n \"name\": \"Email Address\"\n },\n \"value\": \"[email protected]\"\n },\n {\n \"attributeKey\": {\n \"key\": \"firstName\",\n \"name\": \"First Name\"\n },\n \"value\": \"John\"\n },\n {\n \"attributeKey\": {\n \"key\": \"lastName\",\n \"name\": \"Last Name\"\n },\n \"value\": \"Doe\"\n }\n ]\n },\n {\n \"attributes\": [\n {\n \"attributeKey\": {\n \"key\": \"email\",\n \"name\": \"Email Address\"\n },\n \"value\": \"[email protected]\"\n },\n {\n \"attributeKey\": {\n \"key\": \"firstName\",\n \"name\": \"First Name\"\n },\n \"value\": \"Jane\"\n },\n {\n \"attributeKey\": {\n \"key\": \"lastName\",\n \"name\": \"Last Name\"\n },\n \"value\": \"Smith\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"status": "<string>",
"message": "<string>"
}
}{
"data": {
"status": "<string>",
"message": "<string>",
"skippedContacts": [
{
"index": 123,
"userId": "<string>"
}
]
}
}Management API - Contacts
Upload Bulk Contacts
Uploads contacts in bulk. This endpoint expects the bulk request shape: contacts must be an array, and each contact item must contain an attributes array of { attributeKey, value } objects. Unlike POST /management/contacts, this endpoint does not accept a top-level attributes object. Each contact must include an email attribute in its attributes array, and that email must be valid. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
PUT
/
management
/
contacts
/
bulk
Upload Bulk Contacts
curl --request PUT \
--url https://app.formbricks.com/api/v2/management/contacts/bulk \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"workspaceId": "ws_01h2xce9q8p3w4x5y6z7a8b9c0",
"contacts": [
{
"attributes": [
{
"attributeKey": {
"key": "email",
"name": "Email Address"
},
"value": "[email protected]"
},
{
"attributeKey": {
"key": "firstName",
"name": "First Name"
},
"value": "John"
},
{
"attributeKey": {
"key": "lastName",
"name": "Last Name"
},
"value": "Doe"
}
]
},
{
"attributes": [
{
"attributeKey": {
"key": "email",
"name": "Email Address"
},
"value": "[email protected]"
},
{
"attributeKey": {
"key": "firstName",
"name": "First Name"
},
"value": "Jane"
},
{
"attributeKey": {
"key": "lastName",
"name": "Last Name"
},
"value": "Smith"
}
]
}
]
}
'import requests
url = "https://app.formbricks.com/api/v2/management/contacts/bulk"
payload = {
"workspaceId": "ws_01h2xce9q8p3w4x5y6z7a8b9c0",
"contacts": [{ "attributes": [
{
"attributeKey": {
"key": "email",
"name": "Email Address"
},
"value": "[email protected]"
},
{
"attributeKey": {
"key": "firstName",
"name": "First Name"
},
"value": "John"
},
{
"attributeKey": {
"key": "lastName",
"name": "Last Name"
},
"value": "Doe"
}
] }, { "attributes": [
{
"attributeKey": {
"key": "email",
"name": "Email Address"
},
"value": "[email protected]"
},
{
"attributeKey": {
"key": "firstName",
"name": "First Name"
},
"value": "Jane"
},
{
"attributeKey": {
"key": "lastName",
"name": "Last Name"
},
"value": "Smith"
}
] }]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaceId: 'ws_01h2xce9q8p3w4x5y6z7a8b9c0',
contacts: [
{
attributes: [
{
attributeKey: {key: 'email', name: 'Email Address'},
value: '[email protected]'
},
{attributeKey: {key: 'firstName', name: 'First Name'}, value: 'John'},
{attributeKey: {key: 'lastName', name: 'Last Name'}, value: 'Doe'}
]
},
{
attributes: [
{
attributeKey: {key: 'email', name: 'Email Address'},
value: '[email protected]'
},
{attributeKey: {key: 'firstName', name: 'First Name'}, value: 'Jane'},
{attributeKey: {key: 'lastName', name: 'Last Name'}, value: 'Smith'}
]
}
]
})
};
fetch('https://app.formbricks.com/api/v2/management/contacts/bulk', 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://app.formbricks.com/api/v2/management/contacts/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'workspaceId' => 'ws_01h2xce9q8p3w4x5y6z7a8b9c0',
'contacts' => [
[
'attributes' => [
[
'attributeKey' => [
'key' => 'email',
'name' => 'Email Address'
],
'value' => '[email protected]'
],
[
'attributeKey' => [
'key' => 'firstName',
'name' => 'First Name'
],
'value' => 'John'
],
[
'attributeKey' => [
'key' => 'lastName',
'name' => 'Last Name'
],
'value' => 'Doe'
]
]
],
[
'attributes' => [
[
'attributeKey' => [
'key' => 'email',
'name' => 'Email Address'
],
'value' => '[email protected]'
],
[
'attributeKey' => [
'key' => 'firstName',
'name' => 'First Name'
],
'value' => 'Jane'
],
[
'attributeKey' => [
'key' => 'lastName',
'name' => 'Last Name'
],
'value' => 'Smith'
]
]
]
]
]),
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://app.formbricks.com/api/v2/management/contacts/bulk"
payload := strings.NewReader("{\n \"workspaceId\": \"ws_01h2xce9q8p3w4x5y6z7a8b9c0\",\n \"contacts\": [\n {\n \"attributes\": [\n {\n \"attributeKey\": {\n \"key\": \"email\",\n \"name\": \"Email Address\"\n },\n \"value\": \"[email protected]\"\n },\n {\n \"attributeKey\": {\n \"key\": \"firstName\",\n \"name\": \"First Name\"\n },\n \"value\": \"John\"\n },\n {\n \"attributeKey\": {\n \"key\": \"lastName\",\n \"name\": \"Last Name\"\n },\n \"value\": \"Doe\"\n }\n ]\n },\n {\n \"attributes\": [\n {\n \"attributeKey\": {\n \"key\": \"email\",\n \"name\": \"Email Address\"\n },\n \"value\": \"[email protected]\"\n },\n {\n \"attributeKey\": {\n \"key\": \"firstName\",\n \"name\": \"First Name\"\n },\n \"value\": \"Jane\"\n },\n {\n \"attributeKey\": {\n \"key\": \"lastName\",\n \"name\": \"Last Name\"\n },\n \"value\": \"Smith\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.formbricks.com/api/v2/management/contacts/bulk")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"ws_01h2xce9q8p3w4x5y6z7a8b9c0\",\n \"contacts\": [\n {\n \"attributes\": [\n {\n \"attributeKey\": {\n \"key\": \"email\",\n \"name\": \"Email Address\"\n },\n \"value\": \"[email protected]\"\n },\n {\n \"attributeKey\": {\n \"key\": \"firstName\",\n \"name\": \"First Name\"\n },\n \"value\": \"John\"\n },\n {\n \"attributeKey\": {\n \"key\": \"lastName\",\n \"name\": \"Last Name\"\n },\n \"value\": \"Doe\"\n }\n ]\n },\n {\n \"attributes\": [\n {\n \"attributeKey\": {\n \"key\": \"email\",\n \"name\": \"Email Address\"\n },\n \"value\": \"[email protected]\"\n },\n {\n \"attributeKey\": {\n \"key\": \"firstName\",\n \"name\": \"First Name\"\n },\n \"value\": \"Jane\"\n },\n {\n \"attributeKey\": {\n \"key\": \"lastName\",\n \"name\": \"Last Name\"\n },\n \"value\": \"Smith\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v2/management/contacts/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"ws_01h2xce9q8p3w4x5y6z7a8b9c0\",\n \"contacts\": [\n {\n \"attributes\": [\n {\n \"attributeKey\": {\n \"key\": \"email\",\n \"name\": \"Email Address\"\n },\n \"value\": \"[email protected]\"\n },\n {\n \"attributeKey\": {\n \"key\": \"firstName\",\n \"name\": \"First Name\"\n },\n \"value\": \"John\"\n },\n {\n \"attributeKey\": {\n \"key\": \"lastName\",\n \"name\": \"Last Name\"\n },\n \"value\": \"Doe\"\n }\n ]\n },\n {\n \"attributes\": [\n {\n \"attributeKey\": {\n \"key\": \"email\",\n \"name\": \"Email Address\"\n },\n \"value\": \"[email protected]\"\n },\n {\n \"attributeKey\": {\n \"key\": \"firstName\",\n \"name\": \"First Name\"\n },\n \"value\": \"Jane\"\n },\n {\n \"attributeKey\": {\n \"key\": \"lastName\",\n \"name\": \"Last Name\"\n },\n \"value\": \"Smith\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"status": "<string>",
"message": "<string>"
}
}{
"data": {
"status": "<string>",
"message": "<string>",
"skippedContacts": [
{
"index": 123,
"userId": "<string>"
}
]
}
}Authorizations
Use your Formbricks x-api-key to authenticate.
Body
application/json
The contacts to upload. Use the full nested bulk body shown in the example or cURL snippet: { workspaceId, environmentId (deprecated), contacts: [{ attributes: [{ attributeKey: { key, name }, value }] }] }. Each contact must include an email attribute inside its attributes array.
Response
Contacts uploaded successfully.
Show child attributes
Show child attributes
Was this page helpful?
⌘I