Skip to main content
POST
/
management
/
contacts
Create a contact
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": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "userId": "h2xce9q8p3w4x5y6z7a8b9c1"
  }
}
'
{
  "id": "ctc_01h2xce9q8p3w4x5y6z7a8b9c2",
  "createdAt": "2023-01-01T12:00:00.000Z",
  "workspaceId": "ws_01h2xce9q8p3w4x5y6z7a8b9c0",
  "environmentId": "env_01h2xce9q8p3w4x5y6z7a8b9c0",
  "attributes": {
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "userId": "h2xce9q8p3w4x5y6z7a8b9c1"
  }
}

Documentation Index

Fetch the complete documentation index at: https://formbricks.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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
​
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