Skip to main content
DELETE
Delete a custom field

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

field_key
string
required

The field's key, as GET /v1/fields lists it

Required string length: 1 - 255
Example:

"renewal_risk__c_"

Query Parameters

object
string
required

The object the field belongs to: one of account, contact, opportunity, project, task, user, or a custom object's key. A project's and a task's custom fields are one set: a delete through either removes the field from both

Required string length: 1 - 200

Response

200 - application/json

Successful Response

key
string
required

The deleted field's key

object
string
required

The object named in the request

deleted
boolean
default:true