Sign in

v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
Extensions

Update an Extension

Update an extension by ID.

patch/extensions/{extension_id}

Path parameters

extension_idinteger required

The extension ID of the extension you want to change

Request body

archivedboolean

Whether the extension is archived

descriptionstring

The description for the extension

edit_urlstring

The URL to load when editing the extension

enabledboolean

Whether the extension is enabled

namestring

Name of the extension

Example request

{
  "fields": [
    {
      "api_name": "text",
      "default_value": "My Butterbar",
      "field_type": "text",
      "label": "A text field"
    }
  ],
  "name": "My Extension"
}

Response

Return the updated extension

archivedboolean

Whether the extension is archived

createdstring date-time

The time when the extension was initially created

descriptionstring

The description for the extension

edit_urlstring required

The URL to load when editing the extension

enabledboolean

Whether the extension is enabled. A disabled extension won't appear in the editor and won't be built into the snippet

experiment_countinteger

Number of experiments that reference this extension across all statuses (running, paused, draft, archived). Computed by the upstream service.

idinteger

The unique identifier for the extension

last_modifiedstring date-time

The last time when the extension was modified

namestring required

Name of the extension

project_idinteger required

The project the extension is in

Example response

{
  "experiment_count": 3,
  "fields": [
    {
      "api_name": "text",
      "default_value": "My Butterbar",
      "field_type": "text",
      "label": "A text field"
    }
  ],
  "id": 3000,
  "name": "My Extension",
  "project_id": 1000
}