Free setup on annual plans
Sign up today!
Customer Custom Fields
API Reference: Customer Custom Fields endpoints
The Customer Custom Fields API manages customer-level custom field definitions that can be used across tickets, messages and related workflows.
Overview
Custom field definitions are customer-scoped metadata. Create fixes fieldName and fieldType; update changes display metadata and options.
Current endpoints
Customer custom field endpoints
| Method | Path | Access | Purpose |
|---|---|---|---|
| GET | /api/CustomerCustomFields | Bearer JWT | List custom field definitions for the authenticated customer. |
| POST | /api/CustomerCustomFields | Bearer JWT | Create a custom field definition. |
| GET | /api/CustomerCustomFields/{id} | Bearer JWT | Read one custom field definition. |
| PUT | /api/CustomerCustomFields/{id} | Bearer JWT | Update display name, description, order and options. |
| DELETE | /api/CustomerCustomFields/{id} | Bearer JWT | Delete one custom field definition. |
Fields and DTOs
DTO structure
CustomFieldDefinitionCreateDTO, UpdateDTO and ReadDTO
Customer-level custom field definitions used by tickets, messages and related workflows.
| Area | Fields | Notes |
|---|---|---|
| Create-only identity | fieldName, fieldType | Set on create and fixed afterwards. Typical field types include text, number, date and dropdown. |
| Display metadata | displayName, description, order | Editable on update. |
| Dropdown options | options | Used for dropdown fields. |
| Read identity | customFieldDefinitionID | Returned on read/list responses. |
Access and errors
Protected endpoints use JWT Bearer authentication and remain scoped to the authenticated customer.
Table of Contents
AnswerPal: AI-powered customer service solutions to elevate your support and communication effortlessly.
Quick Links
Contact
For all support, sales, and partnership inquiries, email us at info@answerpal.eu
AnswerPal
Bisschoppenhoflaan 380
2100 Antwerp
Belgium
+32.36416685
BE 0862.692.858