Zernio
Zernio
API Reference

Custom Fields

List custom field definitionsGETCreate custom fieldPOSTSet custom field valuePUTUpdate custom fieldPATCHDelete custom fieldDELETEClear custom field valueDELETE
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
Custom Fields

Create custom field

Create a new custom field definition. Supported types are text, number, date, boolean, and select.

POST
/v1/custom-fields

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

{  "success": true,  "field": {    "id": "string",    "name": "string",    "slug": "string",    "type": "text",    "options": [      "string"    ],    "createdAt": "2019-08-24T14:15:22Z"  }}
Was this page helpful?

List custom field definitions

Returns all custom field definitions. Optionally filter by profile.

Set custom field value

Set or overwrite a custom field value on a contact. The value type must match the field definition.

profileId*string
name*string
slug?string

Auto-generated from name if not provided

type*string

Value in

  • "text"
  • "number"
  • "date"
  • "boolean"
  • "select"
options?array<string>

Required for select type