Request
URL
PUT https://www.chatbase.co/api/v1/chatbots/{chatbotId}/custom-attributes/{name}
Path Parameters
The ID of the chatbot the custom attribute belongs to
The name of the custom attribute to update
Body Parameters
The new display label for the custom attribute
The new description for the custom attribute
Whether the custom attribute should be archived
Default: false
{
"label": "Updated Label",
"description": "Updated description",
"archived": false
}
Response
Success Response
- Status: 200 OK
- Content-Type: application/json
Show Custom Attribute Object
The unique identifier for the custom attribute
The type of the attribute. One of: text, number, boolean, date
The display label for the attribute
Description of the attribute
Whether the attribute is archived. If true, the attribute cannot be used for new or updated values
{
"message": "Success",
"data": {
"name": "company",
"type": "text",
"label": "Updated Label",
"description": "Updated description",
"archived": false
}
}
Error Responses
400 Bad Request
{
"message": "Invalid request body"
}
401 Unauthorized
- Invalid or missing API key
{
"message": "Unauthorized access"
}
404 Not Found
- Chatbot or custom attribute not found
{
"message": "Custom attribute not found"
}
429 Too Many Requests
{
"message": "Rate limit exceeded"
}
Code Examples
curl -X PUT 'https://www.chatbase.co/api/v1/chatbots/5ba682d23d7cf92bef87bfd4/custom-attributes/company' \
-H 'Authorization: Bearer <YOUR_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"label": "Updated Label",
"description": "Updated description",
"archived": false
}'
