mirror/formbricks
1
0
Fork 0
mirror of https://github.com/formbricks/formbricks.git synced 2026-01-06 00:49:42 -06:00
Code Issues Packages Projects Releases 118 Wiki Activity

docs: fixes the bulk contact upload api docs and adds the email property (#6066)

Browse Source 
Co-authored-by: Johannes <johannes@formbricks.com>
This commit is contained in:
Anshuman Pandey
2025-06-24 14:14:34 +05:30
committed by GitHub
parent 397643330a
commit 51b58be079
8 changed files with 93 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/api-v2-reference/openapi.yml
View File

@@ -1523,12 +1523,15 @@ paths:
put:
operationId: uploadBulkContacts
summary: Upload Bulk Contacts
description: Uploads contacts in bulk
description: Uploads contacts in bulk. Each contact in the payload must have an
'email' attribute present in their attributes array. The email attribute
is mandatory and must be a valid email format.
tags:
- Management API > Contacts
requestBody:
required: true
description: The contacts to upload
description: The contacts to upload. Each contact **must include an 'email'
attribute** in their attributes array.
content:
application/json:
schema:
@@ -1567,6 +1570,35 @@ paths:
required:
- environmentId
- contacts
example:
environmentId: env_01h2xce9q8p3w4x5y6z7a8b9c0
contacts:
- attributes:
- attributeKey:
key: email
name: Email Address
value: john.doe@example.com
- attributeKey:
key: firstName
name: First Name
value: John
- attributeKey:
key: lastName
name: Last Name
value: Doe
- attributes:
- attributeKey:
key: email
name: Email Address
value: jane.smith@example.com
- attributeKey:
key: firstName
name: First Name
value: Jane
- attributeKey:
key: lastName
name: Last Name
value: Smith
responses:
"200":
description: Contacts uploaded successfully.