--- title: "Update an attribute" method: PATCH path: "/v2/{target}/{identifier}/attributes/{attribute}" tags: ["Attributes"] --- # Update an attribute `PATCH /v2/{target}/{identifier}/attributes/{attribute}` Updates a single attribute on a given object or list. When `target` is `objects`, the required scopes are `object_configuration:read-write`. When `target` is `lists`, the required scopes are `list_configuration:read-write`. ## Path parameters - `target` 'objects' | 'lists', required — Whether the attribute is on an object or a list. - `identifier` string, required — A UUID or slug to identify the object or list the attribute belongs to. - `attribute` string, required — A UUID or slug to identify the attribute. ## Request body - object - `data` object, required - `title` string — The name of the attribute. The title will be visible across Attio's UI. - `description` string, nullable — A text description for the attribute. - `api_slug` string — A unique, human-readable slug to access the attribute through URLs and API calls. Formatted in snake case. - `is_required` boolean — When `is_required` is `true`, new records/entries must have a value for this attribute. If `false`, values may be `null`. This value does not affect existing data and you do not need to backfill `null` values if changing `is_required` from `false` to `true`. - `is_unique` boolean — Whether or not new values for this attribute must be unique. Uniqueness restrictions are only applied to new data and do not apply retroactively to previously created data. - `default_value` union — The default value for this attribute. Static values are used to directly populate values using their contents. Dynamic values are used to lookup data at the point of creation. For example, you could use a dynamic value to insert a value for the currently logged in user. Which default values are available is dependent on the type of the attribute. Default values are not currently supported on people or company objects. - object - `type` 'dynamic', required - `template` union, required - 'current-user' — For actor reference attributes, you may pass a dynamic value of `"current-user"`. When creating new records or entries, this will cause the actor reference value to be populated with either the workspace member or API token that created the record/entry. - string — Timestamp attributes may use an ISO 8601 duration as a dynamic value. For example, `"P1M"` would set the value to the current time plus one month. - string — Date attributes may use an ISO 8601 duration as a dynamic value. For example, `"P1M"` would set the value to the current time plus one month. - object - `type` 'static', required - `template` InputValue[], required - union — A union of possible value types, as required in request bodies. - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `config` object — Additional, type-dependent configuration for the attribute. - `currency` object — Configuration available for attributes of type "currency". - `default_currency_code` 'ARS' | 'AUD' | 'BRL' | 'BGN' | 'CAD' | 'CLP' | 'CNY' | 'COP' | 'CZK' | 'DKK' | 'EUR' | 'FJD' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'MYR' | 'MXN' | 'NTD' | 'NZD' | 'NGN' | 'NOK' | 'XPF' | 'PEN' | 'PHP' | 'PLN' | 'GBP' | 'RWF' | 'SAR' | 'SGD' | 'ZAR' | 'SEK' | 'CHF' | 'THB' | 'TRY' | 'AED' | 'UYU' | 'USD', required — The ISO4217 code representing the currency that values for this attribute should be stored in. - `display_type` 'code' | 'name' | 'narrowSymbol' | 'symbol', required — How the currency should be displayed across the app. "code" will display the ISO currency code e.g. "USD", "name" will display the localized currency name e.g. "British pound", "narrowSymbol" will display "$1" instead of "US$1" and "symbol" will display a localized currency symbol such as "$". - `record_reference` object — Configuration available for attributes of type "record-reference". - `allowed_objects` string[], required — A list of slugs or UUIDs to indicate which objects records are allowed to belong to. If `relationship` is also provided, this must contain only the relationship object. - `is_archived` boolean — Whether the attribute has been archived or not. See our [archiving guide](/docs/archiving-vs-deleting) for more information on archiving. ## Response `200` Success - object — Success - `data` Attribute, required - `id` object, required - `workspace_id` string, uuid, required — A UUID representing the workspace this attribute belongs to. - `object_id` string, uuid, required — A UUID to identify the object or list that this attribute belongs to - `attribute_id` string, uuid, required — A UUID to identify this attribute. - `title` string, required — A title for the attribute, to be displayed across the app. - `description` string, nullable, required — A text description of the attribute. - `api_slug` string, required — A unique slug for the attribute for use in API responses and URLs. Formatted in snake case. - `type` 'text' | 'number' | 'checkbox' | 'currency' | 'date' | 'timestamp' | 'rating' | 'status' | 'select' | 'record-reference' | 'actor-reference' | 'location' | 'domain' | 'email-address' | 'phone-number' | 'interaction' | 'personal-name', required — The type of the attribute. - `is_system_attribute` boolean, required — `true` if this is an Attio system-defined attribute, `false` if defined by a user or non-Attio system. - `is_writable` boolean, required — Whether or not this attribute can be written to. It is `false` for protected system attributes, which are usually enriched by Attio. It is also `false` for formula attributes, whose values are calculated automatically. - `is_required` boolean, required — When `is_required` is `true`, new records/entries must have a value for this attribute. If `false`, values may be `null`. This value does not affect existing data and you do not need to backfill `null` values if changing `is_required` from `false` to `true`. - `is_unique` boolean, required — Whether or not new values for this attribute must be unique. Uniqueness restrictions are only applied to new data and do not apply retroactively to previously created data. - `is_multiselect` boolean, required — Whether or not this attribute can have multiple values. Multiselect is only available on some value types. - `is_default_value_enabled` boolean, required — Whether this attribute has a default value enabled. Must be `true` when `is_required` is `true`. - `is_archived` boolean, required — Whether this attribute has been archived. Archived attributes are hidden from most UI, but can be restored either over the API or in workspace settings. See the [guide on archiving and deleting](/docs/archiving-vs-deleting)for more information. - `default_value` union, required — The default value for this attribute. Static values are used to directly populate values using their contents. Dynamic values are used to lookup data at the point of creation. For example, you could use a dynamic value to insert a value for the currently logged in user. Which default values are available is dependent on the type of the attribute. - object - `type` 'dynamic', required - `template` union, required - 'current-user' — For actor reference attributes, you may pass a dynamic value of `"current-user"`. When creating new records or entries, this will cause the actor reference value to be populated with either the workspace member or API token that created the record/entry. - string — Timestamp attributes may use an ISO 8601 duration as a dynamic value. For example, `"P1M"` would set the value to the current time plus one month. - string — Date attributes may use an ISO 8601 duration as a dynamic value. For example, `"P1M"` would set the value to the current time plus one month. - object - `type` 'static', required - `template` OutputValue[], required - union — A union of possible value types, as returned in response bodies. - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `relationship` object, nullable, required — If this attribute is related to another attribute, this is an object that includes an `id` property that identifies the other attribute. `null` means no relationship exists. See [the help center](https://attio.com/help/reference/managing-your-data/attributes#relationship-attributes) for more details about relationship attributes. - `id` object, required - `workspace_id` string, uuid, required — A UUID representing the workspace this attribute belongs to. - `object_id` string, uuid, required — A UUID to identify the object or list that this attribute belongs to - `attribute_id` string, uuid, required — A UUID to identify this attribute. - `object_slug` string, required — The slug of the object that the related attribute belongs to. - `title` string, required — The title of the related attribute. - `api_slug` string, required — The API slug identifying the related attribute. - `is_multiselect` boolean, required — Whether the related attribute supports selecting multiple values. Combined with the parent attribute's `is_multiselect`, this determines the relationship type: both `false` = one-to-one, parent `true` + related `false` = many-to-one, parent `false` + related `true` = one-to-many, both `true` = many-to-many. - `created_at` string, required — When this attribute was created. - `config` object, required — Additional, type-dependent configuration for the attribute. - `currency` object, required — Configuration available for attributes of type "currency". - `default_currency_code` 'ARS' | 'AUD' | 'BRL' | 'BGN' | 'CAD' | 'CLP' | 'CNY' | 'COP' | 'CZK' | 'DKK' | 'EUR' | 'FJD' | 'HKD' | 'HUF' | 'ISK' | 'INR' | 'IDR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'MYR' | 'MXN' | 'NTD' | 'NZD' | 'NGN' | 'NOK' | 'XPF' | 'PEN' | 'PHP' | 'PLN' | 'GBP' | 'RWF' | 'SAR' | 'SGD' | 'ZAR' | 'SEK' | 'CHF' | 'THB' | 'TRY' | 'AED' | 'UYU' | 'USD', nullable, required — The ISO4217 code representing the currency that values for this attribute should be stored in. - `display_type` 'code' | 'name' | 'narrowSymbol' | 'symbol', nullable, required — How the currency should be displayed across the app. "code" will display the ISO currency code e.g. "USD", "name" will display the localized currency name e.g. "British pound", "narrowSymbol" will display "$1" instead of "US$1" and "symbol" will display a localized currency symbol such as "$". - `record_reference` object, required — Configuration available for attributes of type "record-reference". - `allowed_object_ids` string[], nullable, required — A list of UUIDs to indicate which objects records are allowed to belong to. Leave empty to to allow records from all object types. ## Other responses - `400` — Bad Request - `404` — Not Found --- [API](https://skmtc.net/attio/apis/attio-api.md) · [All operations](https://skmtc.net/attio/apis/attio-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/attio/attio-api/versions/40a8e41d06a2/schema)