Merge duplicate custom fields

POST

fields

{id}

merge

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

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

const { data, error } = await norbelys.fields.merge("fld_3n7p1q", { targetId: "fld_canonical_company" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "alreadyEqual": 1,
  "conflicts": 1,
  "contactsScanned": 1,
  "copied": 1,
  "defaultConflict": true,
  "discardedEmpty": 1,
  "source": {
    "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>"
  },
  "sourceArchived": true,
  "sourceValuesRemaining": 1,
  "target": {
    "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>"
  },
  "object": "field_merge"
}

{
  "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_….

Headers

Idempotency-Key

string

Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Maximum string length: 255

Path Parameters

string

required

The duplicate/source field id whose values should be migrated.

Example:

"fld_legacy_company"

Body

application/json

targetId

string

required

The canonical destination field id.

Example:

"fld_canonical_company"

Response

alreadyEqual

integer

required

Contacts whose identical source value was removed because the target already contained it.

Required range: x >= 0

conflicts

integer

required

Contacts with two different non-empty values. Both values were preserved and the source field remains active.

Required range: x >= 0

contactsScanned

integer

required

Contacts that had the source key when the merge began.

Required range: x >= 0

copied

integer

required

Contacts whose source value was copied into an empty target and then removed from the source key.

Required range: x >= 0

defaultConflict

boolean

required

Whether source and target define different non-null defaults. A conflict keeps the source field active.

discardedEmpty

integer

required

Contacts whose source key was removed because its value was null or blank.

Required range: x >= 0

source

Field · object

required

The source field after the merge.

Show child attributes

sourceArchived

boolean

required

Whether the source was archived. This is true only when no source values or default conflict remain.

sourceValuesRemaining

integer

required

Contacts that still carry the source key, normally because its value conflicts with the target.

Required range: x >= 0

target

Field · object

required

The canonical target field after the merge.

Show child attributes

object

any

default:field_merge

Always "field_merge" — the resource discriminator.

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

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

const { data, error } = await norbelys.fields.merge("fld_3n7p1q", { targetId: "fld_canonical_company" });
if (error) {
  throw new Error(error.error.message);
}
console.log(data);

{
  "alreadyEqual": 1,
  "conflicts": 1,
  "contactsScanned": 1,
  "copied": 1,
  "defaultConflict": true,
  "discardedEmpty": 1,
  "source": {
    "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>"
  },
  "sourceArchived": true,
  "sourceValuesRemaining": 1,
  "target": {
    "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>"
  },
  "object": "field_merge"
}

{
  "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

Merge duplicate custom fields

Authorizations

Headers

Path Parameters

Body

Response