Contacts
Add Contacts to Chatbase
Add one or more contacts to a chatbot.
Request
URL
Path Parameters
The ID of the chatbot to add contacts to
Headers
Bearer <YOUR_API_KEY>
application/json
Body Parameters
Array of contact objects to add.
- Minimum: 1 contact
- Maximum: 1000 contacts
Field Handling
Default Fields
Only the following default fields are recognized and stored:
external_id
name
email
phonenumber
Any other fields outside of custom_attributes
will be silently stripped from the data.
Custom Attributes
Fields under custom_attributes
go through the following validation:
- Each field is checked against the chatbot’s custom attribute schema
- Unknown fields (not in schema) are silently stripped
- Fields that exist in the schema are validated:
- Check if the field is archived (error if archived)
- Validate the value against the field’s type
- Store the value if validation passes
Example Request Body
Response
Success Response
- Status: 200 OK
- Content-Type: application/json
Success message
Error Responses
400 Bad Request
- Invalid request body
- Maximum contacts limit reached
- Invalid custom attribute value type
- Archived custom attribute used
401 Unauthorized
- Invalid or missing API key
404 Not Found
- Chatbot not found
409 Conflict
- Email already exists
429 Too Many Requests
- Rate limit exceeded