SAsaleshandy
fields

Update a custom field

Changed on

Updates the label, fallback text, and/or tags of an existing custom field. Only custom (non-system) fields can be updated. Use the field ID returned by the GET /fields endpoint.

patch/v1/fields/{fieldId}

Request

Path parameters

fieldIdstring required

Public custom-field ID returned by field read/list APIs.

Request body

labelstring

The new display name for the custom field. This label will appear in the prospect profile and throughout the application.

fallbackTextstring

Updated placeholder text to display when the field has no value for a prospect.

tagsstring[]

Full-replacement list of tags for this field (separate namespace from Prospect Tags). Omit to leave tags unchanged; pass an empty array to remove all tags. Tags present here but not currently on the field are added (case-insensitively resolved, created if new); tags currently on the field but absent here are removed.

Example request

{
  "label": "LinkedIn URL",
  "fallbackText": "Not available",
  "tags": [
    "CRM",
    "Sales"
  ]
}

Response

Custom field updated successfully

unknown required

Example response

{
  "message": "Custom field updated successfully"
}

Changes