Contacts

Update custom attribute

Updates an existing custom attribute

put/chatbots/{chatbotId}/custom-attributes/{name}

Request

Base URL
https://www.chatbase.co/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/chatbase/apis/chatbase-api-v1/docs/chatbots/:chatbotId/custom-attributes/:name/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

chatbotIdstring required

ID of the chatbot

namestring required

Name of the custom attribute

Request body

labelstring

Display label for the attribute

descriptionstring

Description of the attribute

archivedboolean

Whether the attribute is archived

Example request

{
  "label": "Department",
  "description": "Updated employee department"
}

Response

Custom attribute updated successfully

messagestring

Example response

{
  "message": "Success",
  "data": {
    "name": "department",
    "label": "Department",
    "type": "text",
    "description": "Employee department"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.