fields

Update a custom field

Updates the label or fallback text 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}

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.

Example request

{
  "label": "LinkedIn URL",
  "fallbackText": "Not available"
}

Response

Custom field updated successfully

{"stackTrail":"paths:/v1/fields/{fieldId}:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"message":"Custom field updated successfully"}}

Example response

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.