Skip to main content
POST
/
api
/
v1
/
businesses
/
{businessId}
/
custom-fields
Error
A valid request URL is required to generate request examples
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "businessId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "company_size",
    "label": "Company Size",
    "type": "TEXT",
    "displayOrder": 123,
    "isActive": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key prefixed with sk-ak-. Pass as Authorization: Bearer sk-ak-...

Path Parameters

​
businessId
string<uuid>
required

The business ID

Body

application/json

Custom field data

​
key
string
required

Lowercase alphanumeric with underscores only

Required string length: 1 - 512
Pattern: ^[a-z0-9_]+$
​
label
string
required
Required string length: 1 - 512
​
type
enum<string>
required
Available options:
TEXT,
NUMBER,
DATE,
EMAIL,
PHONE,
URL,
SINGLE_SELECT,
MULTI_SELECT
​
displayOrder
integer
default:0
Required range: x >= 0
​
isActive
boolean
default:true

Response

Custom field created

​
data
object