curl --request POST \
--url https://app.formbricks.com/api/v2/management/contact-attribute-keys \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data @- <<EOF
{
"key": "email",
"name": "Email Address",
"description": "The user's email address",
"workspaceId": "<string>",
"environmentId": "<string>"
}
EOFimport requests
url = "https://app.formbricks.com/api/v2/management/contact-attribute-keys"
payload = {
"key": "email",
"name": "Email Address",
"description": "The user's email address",
"workspaceId": "<string>",
"environmentId": "<string>"
}
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({
key: 'email',
name: 'Email Address',
description: 'The user\'s email address',
workspaceId: '<string>',
environmentId: '<string>'
})
};
fetch('https://app.formbricks.com/api/v2/management/contact-attribute-keys', 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/contact-attribute-keys",
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([
'key' => 'email',
'name' => 'Email Address',
'description' => 'The user\'s email address',
'workspaceId' => '<string>',
'environmentId' => '<string>'
]),
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/contact-attribute-keys"
payload := strings.NewReader("{\n \"key\": \"email\",\n \"name\": \"Email Address\",\n \"description\": \"The user's email address\",\n \"workspaceId\": \"<string>\",\n \"environmentId\": \"<string>\"\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://app.formbricks.com/api/v2/management/contact-attribute-keys")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"email\",\n \"name\": \"Email Address\",\n \"description\": \"The user's email address\",\n \"workspaceId\": \"<string>\",\n \"environmentId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v2/management/contact-attribute-keys")
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 \"key\": \"email\",\n \"name\": \"Email Address\",\n \"description\": \"The user's email address\",\n \"workspaceId\": \"<string>\",\n \"environmentId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"isUnique": false,
"key": "email",
"name": "Email Address",
"description": "The user's email address",
"type": "custom",
"workspaceId": "<string>",
"environmentId": "<string>"
}Create a contact attribute key
Creates a contact attribute key in the database. Note - Environments are deprecated. Use Workspace/workspaceId terminology.
curl --request POST \
--url https://app.formbricks.com/api/v2/management/contact-attribute-keys \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data @- <<EOF
{
"key": "email",
"name": "Email Address",
"description": "The user's email address",
"workspaceId": "<string>",
"environmentId": "<string>"
}
EOFimport requests
url = "https://app.formbricks.com/api/v2/management/contact-attribute-keys"
payload = {
"key": "email",
"name": "Email Address",
"description": "The user's email address",
"workspaceId": "<string>",
"environmentId": "<string>"
}
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({
key: 'email',
name: 'Email Address',
description: 'The user\'s email address',
workspaceId: '<string>',
environmentId: '<string>'
})
};
fetch('https://app.formbricks.com/api/v2/management/contact-attribute-keys', 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/contact-attribute-keys",
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([
'key' => 'email',
'name' => 'Email Address',
'description' => 'The user\'s email address',
'workspaceId' => '<string>',
'environmentId' => '<string>'
]),
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/contact-attribute-keys"
payload := strings.NewReader("{\n \"key\": \"email\",\n \"name\": \"Email Address\",\n \"description\": \"The user's email address\",\n \"workspaceId\": \"<string>\",\n \"environmentId\": \"<string>\"\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://app.formbricks.com/api/v2/management/contact-attribute-keys")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"email\",\n \"name\": \"Email Address\",\n \"description\": \"The user's email address\",\n \"workspaceId\": \"<string>\",\n \"environmentId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v2/management/contact-attribute-keys")
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 \"key\": \"email\",\n \"name\": \"Email Address\",\n \"description\": \"The user's email address\",\n \"workspaceId\": \"<string>\",\n \"environmentId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"createdAt": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"isUnique": false,
"key": "email",
"name": "Email Address",
"description": "The user's email address",
"type": "custom",
"workspaceId": "<string>",
"environmentId": "<string>"
}Authorizations
Use your Formbricks x-api-key to authenticate.
Body
The contact attribute key to create
Input data for creating or updating a contact attribute
The attribute identifier used in the system
"email"
Display name for the attribute
"Email Address"
Description of the attribute
"The user's email address"
The ID of the Workspace this attribute belongs to
Deprecated alias for workspaceId.
Response
Contact attribute key created successfully.
The ID of the contact attribute key
The date and time the contact attribute key was created
"2021-01-01T00:00:00.000Z"
The date and time the contact attribute key was last updated
"2021-01-01T00:00:00.000Z"
Whether the attribute must have unique values across contacts
false
The attribute identifier used in the system
"email"
Display name for the attribute
"Email Address"
Description of the attribute
"The user's email address"
Whether this is a default or custom attribute
default, custom "custom"
The ID of the Workspace this attribute belongs to
Deprecated alias for workspaceId.
Was this page helpful?