Create or update a custom UI extension

put

https://developers.bloomreach.io/management/integrations/ui-extensions/v1/{id}

Create or update a UI extension to be managed through the Integrations Library. When creating an extension, its ID must be unique across all existing extensions, whether or not managed through the Integrations Library.
The following will cause an HTTP 409 Conflict response:

No version is provided, and the provided ID exists;
A version is provided, and the provided ID does not exist;
A version is provided, but its value is not the latest.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

ID of the extension. Must be unique and only contain alphanumeric characters

Body Params

Represents configurations for a UI extension. See official documentation

string

ID of a UI extension

displayName

string

required

Display name of the extension

url

string

required

The URL on which the extension is served

config

string

required

JSON string to configure the Open UI extension

extensionPoint

string

enum

required

The type of extension point. For extensions on content-type fields, this is always 'document.field'

Allowed:

height

int32

The initial height of the iframe in pixels (default is 60)

description

string

Description of the extension

logo

string

Logo (Icon) of the extension. Should be a base64 string representation of the image

package

string

The relative path of the UI Extensions Package where this extension is installed from, e.g. bynder/v1

connect-src

array of strings

URLs for external systems that need to be called by an extension

connect-src

frame-ancestors

array of strings

URLs for external systems that need to be loaded in child iframes by an extension

frame-ancestors

frame-src

array of strings

URLs for external servers that host extensions

frame-src

img-src

array of strings

URLs for external systems that host images used or exposed by extensions

img-src

script-src

array of strings

URLs for external systems that host scripts used by extensions

script-src

style-src

array of strings

URLs for external systems that host styles used by extensions

style-src

font-src

array of strings

URLs for external systems that host fonts used by extensions

font-src

media-src

array of strings

URLs for external systems that host media used by extensions

media-src

Headers

X-Resource-Version

string

Resource's version. Must be used in any subsequent update requests of this resource. Can be obtained when GETting the resource

Responses

403

Forbidden

409

Conflict

200OK

201Created