Update an Attribute

1 min

PATCH

https://api.optimizely.com/v2/attributes/{attribute_id}

Update an Attribute by ID

Path Parameters

attribute_idinteger<int64>required
Description
The ID of the Attribute you'd like to update
Format
int64

Body Parameters

bodyAttributeUpdaterequired
Description
A string in JSON format that includes all the fields you'd like to change for an Attribute
- archivedboolean
  Description
  Whether or not the Attribute has been archived
  Default
  false
- descriptionstring
  Description
  A short description of the Attribute
- keystring
  Example
  subscriber_status
  Description
  Unique string identifier for this Attribute within the project
  Max Length
  64
  Pattern
  ^[a-zA-Z0-9_\- .]+$
- namestring
  Example
  Subscriber Status
  Description
  The name of the Attribute

Responses

200Successfully updated the Attribute

Attribute
- archivedboolean
  Description
  Whether or not the Attribute has been archived
  Default
  false
- condition_typestring<custom_attribute | custom_dimension>
  Description
  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.
  Default
  custom_attribute
  Allowed
  custom_attributecustom_dimension
- descriptionstring
  Description
  A short description of the Attribute
- idinteger<int64>
  Description
  The unique identifier for the Attribute
  Format
  int64
- keystringrequired
  Example
  subscriber_status
  Description
  Unique string identifier for this Attribute within the project
  Max Length
  64
  Pattern
  ^[a-zA-Z0-9_\- .]+$
- last_modifiedstring<date-time>
  Description
  The last time the Attribute was modified
  Format
  date-time
- namestring
  Example
  Subscriber Status
  Description
  The name of the Attribute. For Full Stack projects, the name will be set to the value of the key.
- project_idinteger<int64>required
  Example
  17738411154
  Description
  The ID of the project the Attribute belongs to
  Format
  int64

400Invalid request body content

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have permission to update the specified Attribute.

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

404Attribute not found

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request PATCH \
     --url https://api.optimizely.com/v2/attributes/{attribute_id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'PATCH',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/attributes/{attribute_id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/attributes/{attribute_id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/v2/attributes/{attribute_id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

200

// Successfully updated the Attribute
{
  "archived": false,
  "condition_type": "",
  "description": "",
  "id": "",
  "key": "subscriber_status",
  "last_modified": "",
  "name": "Subscriber Status",
  "project_id": 17738411154
}

400

// Invalid request body content
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to update the specified Attribute.
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

404

// Attribute not found
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}