Archive a custom field within the specified project. Archived fields are excluded from required-value enforcement; the required setting is preserved so it is restored on unarchive.
Successful retrieval of a Custom Field.
\nThe response includes RESTful JSON (https://restfuljson.org/) styled links. If a\nlink is not present in the response, it indicates a user is not authorized to access\nthe related resource.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Represents custom fields for entities\n", "customType": "CustomField", "schema": [ { "name": "archived", "kind": "optional", "type": "boolean", "description": "Whether the custom field is archived. New custom fields are created as unarchived by default.", "example": false }, { "name": "created_by_user_id", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": "Identifier of the user who created this custom field (often an email).
", "example": "user@company.com" }, { "name": "created_time", "kind": "optional", "type": "stringThe type of the custom field (e.g., text, number, boolean, link, label)
", "example": "text", "enum": [ "text", "number", "boolean", "link", "label" ] }, { "name": "id", "kind": "required", "type": "integer", "readOnly": true, "description": "System-generated unique identifier for the CustomField.
", "example": 12345 }, { "name": "key", "kind": "required", "type": "string", "description": "Unique user-defined identifier for the CustomField within the project.\nMust contain only alphanumeric characters, underscores, and hyphens.
", "example": "analytics_team", "maxLength": 64, "pattern": "^[a-zA-Z0-9_\\-]+$" }, { "name": "name", "kind": "required", "type": "string", "description": "Human-readable name for the CustomField displayed in the UI.
", "example": "Analytics Team", "maxLength": 255 }, { "name": "project_id", "kind": "optional", "type": "integerValidation rules for the custom field if applicable.\nAllowed keys depend on field_type:
\nWhether thousand separators should be permitted/displayed.
", "example": true } ] } ], "modelRef": "#/components/schemas/CustomField", "isExpanded": true } ] }, { "statusCode": "400", "description": "Malformed requests and invalid parameter names and types", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Invalid credentials", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Do not have permission to perform the operation", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not found. No content", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "yTIr9s1eEfXtWOaudUC-R", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.optimizely.com/flags/v1//projects/{project_id}/custom_fields/{id}/archived \\\n --header 'accept: application/json'" }, { "id": "6Nykn0534vTjGAVSqeA-h", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.optimizely.com/flags/v1//projects/{project_id}/custom_fields/{id}/archived\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "ghReveN0iULirztrbY-rw", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.optimizely.com/flags/v1//projects/{project_id}/custom_fields/{id}/archived\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "q4XWdWm2QL-YFQqwUkmlU", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.optimizely.com/flags/v1//projects/{project_id}/custom_fields/{id}/archived\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "yTIr9s1eEfXtWOaudUC-R" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Successful retrieval of a Custom Field.\nThe response includes RESTful JSON (https://restfuljson.org/) styled links. If a\nlink is not present in the response, it indicates a user is not authorized to access\nthe related resource.\n{\n \"archived\": false,\n \"created_by_user_id\": \"user@company.com\",\n \"created_time\": \"2024-01-01T10:00:00.000Z\",\n \"default_value\": \"option1\",\n \"description\": \"Custom field to tag experiments owned by the analytics team\",\n \"entity_type\": \"flag\",\n \"field_type\": \"text\",\n \"id\": 12345,\n \"key\": \"analytics_team\",\n \"name\": \"Analytics Team\",\n \"project_id\": 98765,\n \"required\": false,\n \"updated_time\": \"2024-01-01T10:00:00.000Z\",\n \"validation\": {\n \"allow_multi_select\": false,\n \"decimal_places\": 2,\n \"field_options\": [\n \"\"\n ],\n \"max\": 100,\n \"max_length\": 255,\n \"min\": 1,\n \"regex\": \"^[A-Za-z0-9_-]+$\",\n \"use_thousand_separator\": true\n }\n}" }, { "id": "response-1-400", "language": "400", "code": "// Malformed requests and invalid parameter names and types\n" }, { "id": "response-2-401", "language": "401", "code": "// Invalid credentials\n" }, { "id": "response-3-403", "language": "403", "code": "// Do not have permission to perform the operation\n" }, { "id": "response-4-404", "language": "404", "code": "// Not found. No content\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }