API Reference version 2

Create global external page

PUT/v2/extension/externalPage/{key}

Create a global external page.

Dynamically created external pages have the following restrictions:

  • You can only create 10 global external pages
  • You cannot modify an external page that was declared in the descriptor

Path parameters

Type Parameter Description Required?
string key

Unique key (in the context of the integration) to identify this external page.

Valid length range: 1 - 40.

Required

Request body

Type Property Description Required?
string url

The URL of the external page.

Required
object name

The display name of the external page.

string i18n

The optional localization key, used to look up the localized value.

Valid length range: 1 - 40.

string value

The default text.

Valid length range: 1 - 100.

Required
string key

Unique key (in the context of the integration) to identify this external page.

Valid length range: 1 - 40.

Required
201 application/json
Type Property Description Required?
str | int id

The unique identifier for the created entity

Required
object links

An object with the following properties.

Required
string self Required