updateContactCustomField

Edit a contact custom-field DEFINITION in place (id from listContactCustomFields). THIS IS THE CORRECT WAY TO FIX A FIELD created with the wrong name, description, dropdown options or default; do not create a second field. Every field but the id is optional; omitted ones are untouched. type retypes it in place (same id), sent alone or with the options of a new DROPDOWN; refused once a contact has a value, anything uses it, it has a default, or it is a dropdown. options is for DROPDOWN fields ONLY (rejected on any other type) and REPLACES the whole option list: send every option to keep, each existing one as { id, label } (its id from listContactCustomFields, which keeps contact values recorded against it and lets you RENAME it by changing the label), each new one as { label } with no id. An existing option you leave out is REMOVED; if contacts, filters or workflows still reference it the call is rejected until you pass optionDependencyResolutions: call getDeletionImpact with targetKind CONTACT_CUSTOM_FIELD_OPTION and targetId the option id, then hand back its impactVersion plus a replacement option for each. Changing defaultValue fills contacts that show no value; a contact holding a real value is never rewritten. A default no longer among the options is cleared. Names are unique in the organization: a rename onto an existing field name is rejected. System-defined fields (e.g. Buyer/Seller, Source) cannot be renamed, deleted or lose their built-in options; hideOnContactRecord: true takes any field, system ones too, off the contact record (display only, values kept).

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "operationId": "updateContactCustomField",
    "variables": {
      "customFieldId": "<customFieldId>"
    }
  }'

import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.contacts.updateContactCustomField(
  {
    customFieldId: '<customFieldId>'
  },
  { idempotencyKey: crypto.randomUUID() },
)

const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    operationId: 'updateContactCustomField',
    variables: {
      customFieldId: '<customFieldId>'
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

customFieldIdID!required

nameString

typeContactCustomFieldType

DROPDOWNTEXTNUMBERDOLLARDATELINK

descriptionString

options[UpsertCustomFieldOptionInput!]

idID

labelString!required

defaultValueString

optionDependencyResolutions[DependencyResolutionInput!]

impactVersionString!required

replacements[DependencyReplacementSelectionInput!]!required

matchInboundTextsByValueBoolean

hideOnContactRecordBoolean

Every field, all the way down

variables

[
  {
    "name": "customFieldId",
    "type": "ID!",
    "required": true,
    "description": null,
    "defaultValue": null
  },
  {
    "name": "name",
    "type": "String",
    "required": false,
    "description": null,
    "defaultValue": null
  },
  {
    "name": "type",
    "type": "ContactCustomFieldType",
    "required": false,
    "description": null,
    "defaultValue": null,
    "enumValues": [
      "DROPDOWN",
      "TEXT",
      "NUMBER",
      "DOLLAR",
      "DATE",
      "LINK"
    ]
  },
  {
    "name": "description",
    "type": "String",
    "required": false,
    "description": null,
    "defaultValue": null
  },
  {
    "name": "options",
    "type": "[UpsertCustomFieldOptionInput!]",
    "required": false,
    "description": null,
    "defaultValue": null,
    "fields": [
      {
        "name": "id",
        "type": "ID",
        "required": false,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "label",
        "type": "String!",
        "required": true,
        "description": null,
        "defaultValue": null
      }
    ]
  },
  {
    "name": "defaultValue",
    "type": "String",
    "required": false,
    "description": null,
    "defaultValue": null
  },
  {
    "name": "optionDependencyResolutions",
    "type": "[DependencyResolutionInput!]",
    "required": false,
    "description": null,
    "defaultValue": null,
    "fields": [
      {
        "name": "impactVersion",
        "type": "String!",
        "required": true,
        "description": null,
        "defaultValue": null
      },
      {
        "name": "replacements",
        "type": "[DependencyReplacementSelectionInput!]!",
        "required": true,
        "description": null,
        "defaultValue": null,
        "fields": [
          {
            "name": "targetKind",
            "type": "DependencyTargetKind!",
            "required": true,
            "description": null,
            "defaultValue": null,
            "enumValues": [
              "PIPELINE_ITEM",
              "DEAL",
              "PIPELINE_STAGE_PIPELINE_ITEMS",
              "DEAL_STAGE_DEALS",
              "PIPELINE_ITEM_CUSTOM_FIELD",
              "DEAL_CUSTOM_FIELD",
              "PIPELINE_ITEM_CUSTOM_FIELD_OPTION",
              "DEAL_CUSTOM_FIELD_OPTION",
              "PROPERTY_TAG",
              "PROPERTY_LIST",
              "CONTACT_TAG",
              "CONTACT_LIST",
              "CONTACT_CUSTOM_FIELD",
              "CONTACT_CUSTOM_FIELD_OPTION",
              "PIPELINE",
              "DEAL_PIPELINE",
              "PIPELINE_STAGE",
              "DEAL_STAGE",
              "TWILIO_PHONE_NUMBER",
              "EMAIL_IDENTITY",
              "LIBRARY_FOLDER",
              "USER",
              "USER_GROUP",
              "WORKFLOW_GROUP",
              "WORKFLOW_AUTOMATION",
              "CONTENT_TEMPLATE",
              "AGENT",
              "MARKETING_CAMPAIGN",
              "UPLOADED_FILE",
              "WORKFLOW_WEBHOOK_CREDENTIAL",
              "SCRAPER_PIPELINE",
              "FILTER",
              "EMBED_FORM",
              "WORKFLOW_TABLE",
              "WORKFLOW_TABLE_COLUMN",
              "CONTACT",
              "PROPERTY",
              "ORGANIZATION",
              "SLACK_CHANNEL",
              "SLACK_USER",
              "MACHINE_GROUP",
              "MACHINE_HOST"
            ]
          },
          {
            "name": "targetId",
            "type": "ID!",
            "required": true,
            "description": null,
            "defaultValue": null
          },
          {
            "name": "replacementId",
            "type": "ID!",
            "required": true,
            "description": null,
            "defaultValue": null
          }
        ]
      }
    ]
  },
  {
    "name": "matchInboundTextsByValue",
    "type": "Boolean",
    "required": false,
    "description": null,
    "defaultValue": null
  },
  {
    "name": "hideOnContactRecord",
    "type": "Boolean",
    "required": false,
    "description": null,
    "defaultValue": null
  }
]

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape

{
  "data": {
    "contactCustomFieldMutation": {
      "updateCustomField": {
        "id": "<ID>",
        "name": "…",
        "type": "DROPDOWN",
        "description": "…",
        "displayOrder": 0,
        "allowMultiple": true,
        "defaultValue": "…",
        "matchInboundTextsByValue": true,
        "hideOnContactRecord": true
      }
    }
  }
}

Errors

400unknown_variable

A variable the operation does not declare. A typo is refused rather than silently dropped.

401unauthorized

No bearer header, or the key is invalid or revoked.

403insufficient_scope

The key lacks the scope the operation requires.

403forbidden

A referenced record does not exist, was deleted, or is outside your organization. The gateway cannot tell those apart.

409idempotency_conflict

A request with this Idempotency-Key is still in flight.

Idempotency

Send an Idempotency-Key of 1 to 255 characters. A finished request retried with the same key replays its stored response, marked Idempotency-Replayed: true; one still in flight returns 409 idempotency_conflict. Keys expire after 24 hours. Write without fear →

Variables

Response

Errors

Idempotency

Related