---
title: "Archive Attribute"
method: DELETE
path: "/objects/{object_slug}/attributes/{attr_slug}"
tags: ["Objects"]
---

# Archive Attribute

`DELETE /objects/{object_slug}/attributes/{attr_slug}`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/objects/{object_slug}/attributes/{attr_slug}`
- Auth: HTTP bearer

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.

## Path parameters

- `object_slug` string, required
- `attr_slug` string, required

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseAttributeDefinitionResponse
  - `data` AttributeDefinitionResponse, required: One field on a custom object, and the rules its values must satisfy.
    - `slug` string, required: Stable API slug for the attribute, used as a payload key.
    - `title` string, required: Customer-facing field label, distinct from its stable API slug.
    - `description` string, nullable: Customer-configured description of the field.
    - `sort_order` integer: Configured display order; equal values are ordered by API slug.
    - `is_system` boolean: Whether this field is protected as a system attribute.
    - `is_archived` boolean: Archived fields retain their values and can be restored.
    - `attribute_type` string, required: One of the 16 supported attribute types (`text`, `number`, `email_address`, `timestamp`, `select`, `record_reference`, …). Determines how values are validated and canonicalized.
    - `is_required` boolean: Required on create. PATCH may omit it, but cannot clear it with null or an empty multivalue list.
    - `is_unique` boolean: No two active records may hold the same value for this attribute. A collision is rejected with `409 duplicate_active_value`.
    - `is_multiselect` boolean: Values are a list rather than a scalar.
    - `is_default_value_enabled` boolean: Apply the configured default when this field is omitted on create. Never applies on PATCH.
    - `default_value` unknown
    - `config` object: 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.
    - `visible_to_role_ids` string[], nullable: Role ids that may see this field; null means every role. Owners and admins always see every field. A field hidden from the caller is absent from every response. Set it with PATCH on this attribute.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)