Update a field

PATCH

fields

{id}

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.fields.update("fld_3n7p1q", { defaultValue: "…", isFilterable: true, label: "…", options: ["…"] });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "code": "favorite_category",
  "defaultValue": "<string>",
  "id": "fld_tz4a98xat96iws9zmbrgj3a",
  "isFilterable": true,
  "label": "Favorite category",
  "options": [
    "Electronics",
    "Apparel",
    "Home"
  ],
  "order": 0,
  "type": "dropdown",
  "archivedAt": "<unknown>",
  "createdAt": "<unknown>",
  "object": "field",
  "updatedAt": "<unknown>"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Org-scoped Norbelys API key. Create one in Settings → API keys and send it as Authorization: Bearer ak_….

Path Parameters

string

required

The field id to update.

Example:

"fld_tz4a98xat96iws9zmbrgj3a"

Body

application/json

defaultValue

Replace the default for new/imported contacts; null or an empty string disables it.

Maximum string length: 1000

isFilterable

boolean

Whether this field is offered as a segment/list filter.

Example:

true

label

string

New display name for the field.

Required string length: 1 - 100

options

string[] | null

Replace the dropdown's allowed values; null clears them.

Maximum array length: 100

Minimum string length: 1

type

enum<string>

Change the data type: text, email, phone, date, datetime, number, or dropdown.

Available options:

text,

email,

phone,

date,

datetime,

number,

dropdown

Response

code

string

required

The merge tag and storage key, templated as {{ code }}.

Example:

"favorite_category"

defaultValue

required

The value applied to new/imported contacts that omit this field, or null when disabled.

Maximum string length: 1000

string

required

The field id.

Example:

"fld_tz4a98xat96iws9zmbrgj3a"

isFilterable

boolean

required

Whether this field is offered as a segment/list filter.

Example:

true

label

string

required

The human-readable display name for the field.

Example:

"Favorite category"

options

string[] | null

required

Allowed values for a dropdown field; null for other types.

Example:

["Electronics", "Apparel", "Home"]

order

integer

required

Display order among custom fields (lower = first).

Required range: x >= 0

Example:

0

type

enum<string>

required

The data type: text, email, phone, date, datetime, number, or dropdown. email and phone values are validated on write: a phone is normalized to E.164, and an invalid value is dropped without failing the request.

Available options:

text,

email,

phone,

date,

datetime,

number,

dropdown

Example:

"dropdown"

archivedAt

any

When the field was archived (RFC 3339), or null if still active.

createdAt

any

When the field was created (RFC 3339).

object

any

default:field

Always "field" — the resource discriminator.

updatedAt

any

When the field was last updated (RFC 3339).

import { createClient } from "@norbelys/sdk";

const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });

const { data, error } = await norbelys.fields.update("fld_3n7p1q", { defaultValue: "…", isFilterable: true, label: "…", options: ["…"] });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "code": "favorite_category",
  "defaultValue": "<string>",
  "id": "fld_tz4a98xat96iws9zmbrgj3a",
  "isFilterable": true,
  "label": "Favorite category",
  "options": [
    "Electronics",
    "Apparel",
    "Home"
  ],
  "order": 0,
  "type": "dropdown",
  "archivedAt": "<unknown>",
  "createdAt": "<unknown>",
  "object": "field",
  "updatedAt": "<unknown>"
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

{
  "error": {
    "code": "invalid_param",
    "message": "<string>",
    "type": "invalid_request",
    "doc_url": "<string>",
    "hint": "<string>"
  }
}

Analytics

Domains

Fields

Files

Groups

Integrations

Messages

Organization

People

Programs

Segments

Senders

Suppressions

Verify

Authorizations

Path Parameters

Body

Response