nodestash
Custom fields

Delete a custom field definition

Permanently deletes a custom field definition and all associated values. This action cannot be undone.

DELETE
/custom-fields/{id}

Authorization

apiKey
AuthorizationBearer <token>

API key from your nodestash dashboard. Pass as a Bearer token in the Authorization header.

In: header

Path Parameters

id*string

Custom field definition ID (prefixed with cf_).

Match^cf_

Response Body

application/json

application/json

application/json

curl -X DELETE "https://api.nodestash.io/v1/custom-fields/cf_5hJ3kM9pQrVwXyZaB2cD4"
Empty
{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Missing or invalid Authorization header"
  },
  "meta": {
    "request_id": "req_abc123def456"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Contact not found"
  },
  "meta": {
    "request_id": "req_abc123def456"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded"
  },
  "meta": {
    "request_id": "req_abc123def456"
  }
}

Create a custom field definition

Creates a new custom field definition in the authenticated workspace. The `slug` is auto-generated from `name` when omitted. The combination of `entity_type` + `slug` must be unique within the workspace. For `select` and `multi_select` field types, `options` must be provided.

Get a custom field definition

Retrieves a single custom field definition by ID.