Fields

Update Custom Field

PATCH /v1/fields/{fieldId}

PATCH/v1/fields/{fieldId}
PATCH
/v1/fields/{fieldId}

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.

Authorization

x-api-key<token>

API key for Open API authentication

In: header

Request Body

application/jsonRequired

Provide one or both fields to update. label changes the display name of the custom field. fallbackText changes the placeholder shown when a prospect has no value for this field. At least one field must be provided.

labelstring

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

Example: "LinkedIn URL"

fallbackTextstring

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

Example: "Not available"

Path Parameters

fieldIdstring

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

Request Body Examples

{
  "label": "LinkedIn URL"
}

Responses

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

Previous

Create Custom Field

Next

Add Domain to Blacklist

Request

Example:
curl -X PATCH \
  "https://open-api.saleshandy.com/v1/fields/{fieldId}" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "LinkedIn URL"
}'

Response

No response body