Contacts

Create custom attribute

Creates a new custom attribute for contacts

post/chatbots/{chatbotId}/custom-attributes

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/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

chatbotIdstring required

ID of the chatbot

Request body

namestring required

Attribute name (must start with a letter and can only contain letters, numbers, underscores, and hyphens)

labelstring

Display label for the attribute

type'text' | 'number' | 'boolean' | 'date' required

Attribute data type

descriptionstring

Description of the attribute

archivedboolean

Whether the attribute is archived

Example request

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

Response

Custom attribute created 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.