POST https://chatloka.net/api/v1/contacts/custom-fields

Create Custom Field

Create a custom field definition.

Required scope: contacts:write

How to Use This Endpoint

1. Authentication

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Body Parameters

Field	Type	Required	Description
`name`	`string`	Required	Display name
`key`	`string`	Required	Unique key (lowercase alphanumeric + underscores)
`field_type`	`string`	Required	text \| number \| email \| phone \| url \| date \| textarea \| select \| multi_select
`options`	`array`	Optional	Options for select/multi_select fields (required when field_type is select or multi_select)
`is_required`	`boolean`	Optional	Whether field is required
`max_length`	`integer`	Optional	Max length (1-10000)
`sort_order`	`integer`	Optional	Sort order (min 0)
`description`	`string`	Optional	Field description
`placeholder`	`string`	Optional	Placeholder text
`is_active`	`boolean`	Optional	Whether field is active

Request Body

application/json

{ "name": "Company", "key": "company", "field_type": "text", "is_required": false }

Example Request

bash

curl -X POST 'https://chatloka.net/api/v1/contacts/custom-fields' \
  -H 'Authorization: Bearer $API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Company", "key": "company", "field_type": "text", "is_required": false }'

Response

201 Created

application/json

{ "success": true, "data": { "id": 1, "name": "Company", "key": "company", "field_type": "text", "options": null, "is_required": false, "max_length": null, "sort_order": 0, "description": null, "placeholder": null, "is_active": true, "created_at": "2026-07-14T10:30:00+00:00", "updated_at": "2026-07-14T10:30:00+00:00" }, "message": "Custom field created successfully" }

Error Responses

401 UNAUTHORIZED

{ "success": false, "error": { "code": "UNAUTHORIZED", "message": "Invalid or revoked API key" } }

403 FORBIDDEN

{ "success": false, "error": { "code": "FORBIDDEN", "message": "You do not have permission to access this resource." } }

422 VALIDATION_ERROR

{ "success": false, "error": { "code": "VALIDATION_ERROR", "message": "The given data was invalid.", "details": { "field": ["The field is required."] } } }

429 RATE_LIMIT_EXCEEDED

{ "success": false, "error": { "code": "RATE_LIMIT_EXCEEDED", "message": "Too many requests. Please slow down.", "retry_after": 60 } }

Back to Custom Fields

Get Custom Field Update Custom Field

Stop Losing Customers
to Slow Responses

Every minute you wait is revenue walking out the door. Join hundreds of businesses who transformed their customer communication with ChatOn.

50%

Faster Response

24/7

AI Support

40%

Higher Conversion

No credit card required

Setup in 5 minutes

Cancel anytime

✓ 30-day money-back guarantee

Create Custom Field

How to Use This Endpoint

Body Parameters

Request Body

Example Request

Response

Error Responses

Stop Losing Customers
to Slow Responses

🍪 We use cookies

Cookie Preferences

Create Custom Field

How to Use This Endpoint

Body Parameters

Request Body

Example Request

Response

Error Responses

Stop Losing Customers to Slow Responses

🍪 We use cookies

Cookie Preferences

Stop Losing Customers
to Slow Responses