Create a contact

Creates a single contact in the database. This endpoint expects a top-level attributes object. For bulk uploads, use PUT /management/contacts/bulk, which expects contacts[].attributes[] instead. Each contact must have a valid email address in the attributes. All attribute keys must already exist in the Workspace. The email is used as the unique identifier along with the Workspace. Note - Environments are deprecated. Use Workspace/workspaceId terminology.

POST /management/contacts

Create a contact

cURL

curl --request POST \
  --url https://app.formbricks.com/api/v2/management/contacts \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "workspaceId": "ws_01h2xce9q8p3w4x5y6z7a8b9c0",
  "attributes": {
    "email": "[e-mail]",
    "firstName": "John",
    "lastName": "Doe",
    "userId": "h2xce9q8p3w4x5y6z7a8b9c1"
  }
}
'

import requests

url = "https://app.formbricks.com/api/v2/management/contacts"

payload = {
    "workspaceId": "ws_01h2xce9q8p3w4x5y6z7a8b9c0",
    "attributes": {
        "email": "[e-mail]",
        "firstName": "John",
        "lastName": "Doe",
        "userId": "h2xce9q8p3w4x5y6z7a8b9c1"
    }
}
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({
    workspaceId: 'ws_01h2xce9q8p3w4x5y6z7a8b9c0',
    attributes: {
      email: '[e-mail]',
      firstName: 'John',
      lastName: 'Doe',
      userId: 'h2xce9q8p3w4x5y6z7a8b9c1'
    }
  })
};

fetch('https://app.formbricks.com/api/v2/management/contacts', 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",
  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([
    'workspaceId' => 'ws_01h2xce9q8p3w4x5y6z7a8b9c0',
    'attributes' => [
        'email' => '[e-mail]',
        'firstName' => 'John',
        'lastName' => 'Doe',
        'userId' => 'h2xce9q8p3w4x5y6z7a8b9c1'
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"workspaceId\": \"ws_01h2xce9q8p3w4x5y6z7a8b9c0\",\n  \"attributes\": {\n    \"email\": \"[e-mail]\",\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\",\n    \"userId\": \"h2xce9q8p3w4x5y6z7a8b9c1\"\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://app.formbricks.com/api/v2/management/contacts")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"ws_01h2xce9q8p3w4x5y6z7a8b9c0\",\n  \"attributes\": {\n    \"email\": \"[e-mail]\",\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\",\n    \"userId\": \"h2xce9q8p3w4x5y6z7a8b9c1\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.formbricks.com/api/v2/management/contacts")

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  \"workspaceId\": \"ws_01h2xce9q8p3w4x5y6z7a8b9c0\",\n  \"attributes\": {\n    \"email\": \"[e-mail]\",\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\",\n    \"userId\": \"h2xce9q8p3w4x5y6z7a8b9c1\"\n  }\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": "ctc_01h2xce9q8p3w4x5y6z7a8b9c2",
  "createdAt": "2023-01-01T12:00:00.000Z",
  "workspaceId": "ws_01h2xce9q8p3w4x5y6z7a8b9c0",
  "environmentId": "env_01h2xce9q8p3w4x5y6z7a8b9c0",
  "attributes": {
    "email": "[e-mail]",
    "firstName": "John",
    "lastName": "Doe",
    "userId": "h2xce9q8p3w4x5y6z7a8b9c1"
  }
}

Authorizations

x-api-key · string · header · required

Use your Formbricks x-api-key to authenticate.

Body

application/json

The single contact to create. Must include a top-level attributes object with an email attribute, and all attribute keys must already exist in the Workspace. Note - Environments are deprecated. Use Workspace/workspaceId terminology.

workspaceId · string · required

attributes · object · required

Show child attributes

environmentId · string · deprecated

Deprecated alias for workspaceId.

Response

201 - application/json

Contact created successfully.

id · string

createdAt · string

workspaceId · string

environmentId · string · deprecated

Deprecated alias for workspaceId.

attributes · object

Show child attributes