Skip to content

Delete Field

DELETE
/fields/{column_id}

Soft-delete a custom field (column).

Always org-scoped (you can only delete columns in your own org). Pass list_id to additionally require that the column belong to a specific list — that’s the safer default for list-scoped agents since the org may have many custom columns across different lists.

Authorizations

Parameters

Path Parameters

column_id
required

Column ID to delete

integer

Column ID to delete

Query Parameters

entity

Target entity: ‘contacts’ or ‘companies’

string
default: contacts

Target entity: ‘contacts’ or ‘companies’

list_id
Any of:
integer

Optional list scope guard. If provided, the column must belong to this list or the request returns 404. Use this to prevent an agent with narrow intent from accidentally deleting a column on a different list in the same org.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
column_id
required
integer
deleted
boolean
default: true
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string