Archive Attribute
DELETE /objects/{object_slug}/attributes/{attr_slug}
Archive a custom field, retaining its values. Restore with PATCH is_archived=false. Refused (409
formula_dependency) while a computed field reads it, with every dependent the credential may see.
Authorizations
Parameters
Path Parameters
Header Parameters
Responses
200
Successful Response
object
One field on a custom object, and the rules its values must satisfy.
object
One of the 16 supported attribute types (text, number, email_address, timestamp, select, record_reference, …). Determines how values are validated and canonicalized.
Type-specific configuration, e.g. select options. Record references require target_object and must resolve to active records in that object within the caller’s organization and app.
object
Configured create default. Enabled non-null defaults pass the same validation as explicit values.
Archived fields retain their values and can be restored.
Apply the configured default when this field is omitted on create. Never applies on PATCH.
Values are a list rather than a scalar.
Required on create. PATCH may omit it, but cannot clear it with null or an empty multivalue list.
Whether this field is protected as a system attribute.
No two active records may hold the same value for this attribute. A collision is rejected with 409 duplicate_active_value.
Stable API slug for the attribute, used as a payload key.
Configured display order; equal values are ordered by API slug.
Customer-facing field label, distinct from its stable API slug.
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error