API v2 Documentation (Draft)
Client API > Response
Client API > Contacts
Client API > Display
Client API > Environment
Client API > User
Client API > File Upload
Roles
Me
Management API > Responses
Management API > Contacts
Management API > Contact Attribute Keys
Management API > Surveys > Contact Links
Management API > Webhooks
Organizations API > Teams
Organizations API > Project Teams
Organizations API > Users
Create a contact attribute key
Creates a contact attribute key in the database.
POST
/
contact-attribute-keys
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 '{
"key": "email",
"name": "Email Address",
"description": "The user'\''s email address",
"environmentId": "<string>"
}'
{
"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",
"environmentId": "<string>"
}
Authorizations
Use your Formbricks x-api-key to authenticate.
Body
application/json
The contact attribute key to create
Input data for creating or updating a contact attribute
Response
201 - application/json
Contact attribute key created successfully.
The response is of type object
.
Was this page helpful?
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 '{
"key": "email",
"name": "Email Address",
"description": "The user'\''s email address",
"environmentId": "<string>"
}'
{
"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",
"environmentId": "<string>"
}