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

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": "[e-mail]"
        },
        {
          "attributeKey": {
            "key": "firstName",
            "name": "First Name"
          },
          "value": "John"
        },
        {
          "attributeKey": {
            "key": "lastName",
            "name": "Last Name"
          },
          "value": "Doe"
        }
      ]
    },
    {
      "attributes": [
        {
          "attributeKey": {
            "key": "email",
            "name": "Email Address"
          },
          "value": "[e-mail]"
        },
        {
          "attributeKey": {
            "key": "firstName",
            "name": "First Name"
          },
          "value": "Jane"
        },
        {
          "attributeKey": {
            "key": "lastName",
            "name": "Last Name"
          },
          "value": "Smith"
        }
      ]
    }
  ]
}
'

200

{
  "data": {
    "status": "<string>",
    "message": "<string>"
  }
}

Authorizations

x-api-key · string · header · required

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.

workspaceId · string · required

contacts · object[] · required

Maximum array length: 250

Show child attributes

environmentId · string · deprecated

Deprecated alias for workspaceId.

Response

200

application/json

Contacts uploaded successfully.

data · object · required

Show child attributes