v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB

Attributes

Update an Attribute

Update an Attribute by ID

patch/attributes/{attribute_id}

Path parameters

attribute_idinteger required

The ID of the Attribute you'd like to update

Request body

archivedboolean

Whether or not the Attribute has been archived

descriptionstring

A short description of the Attribute

keystring

Unique string identifier for this Attribute within the project

namestring

The name of the Attribute

Example request

{
  "key": "subscriber_status",
  "name": "Subscriber Status"
}

Response

Successfully updated the Attribute

archivedboolean

Whether or not the Attribute has been archived

condition_type'custom_attribute' | 'custom_dimension'

Whether this Attribute is a custom dimension or custom attribute. If this is a custom dimension, it belongs to an Optimizely Classic experiment and is read-only.

descriptionstring

A short description of the Attribute

idinteger

The unique identifier for the Attribute

keystring required

Unique string identifier for this Attribute within the project

last_modifiedstring date-time

The last time the Attribute was modified

namestring

The name of the Attribute. For Full Stack projects, the name will be set to the value of the key.

project_idinteger required

The ID of the project the Attribute belongs to

Example response

{
  "key": "subscriber_status",
  "name": "Subscriber Status",
  "project_id": 17738411154
}