Skip to contentSkip to navigation

Delete Lead Field

Delete a lead field and its value on every lead.

DELETE /api/v1/lead-fields/{key}

Removes the definition and the key from every lead's customFields in the workspace. This cannot be undone.

Path Parameters

key string path required

The field's name, URL-encoded.

Response

data object
Result
leadsUpdated integer
Leads that had the key and lost it.

Rate Limit

  • 120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Was this page helpful?