v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Update

Update the manifest of an App.

post/{app_uuid}

Path parameters

app_uuidstring required

UUID of the App

Headers

authorizationstring

Your App Account's username and password, base64'd.

Request body

UUIDstring

UUID of the App

base_sso_urlstring

URL of your App UI where Duda should SSO users into.

default_plan_uuidstring

Skips the select plan selection page and allows users to install only a specific starting plan. Plan must be free or trial.

installation_endpointstring

URL Where Duda will notify when a website installs your App.

is_in_betaboolean

If the App should be shown as 'coming soon' in the App Store.

public_keystring

Your Apps public key, generated at time of App creation. Will never change.

required_fieldsstring[]

Required fields that must exist in the content library before installing. Can be "EMAIL" and "LOCATION".

scopesstring[]

An array of strings of supported scopes. See documentation for all supported scopes.

supported_localesstring[]

Two character language codes your App supports.

uninstallation_endpointstring

URL Where Duda will notify when someone uninstalls your App.

updowngrade_installation_endpointstring

URL Where Duda will notify upon plan upgrade or change of state for your App.

visible_to_clientsboolean

If the App will be shown to end clients (customers of an agency)

window_type'IFRAME' | 'NEW_TAB'

How your App SSO is opened from Duda. IFRAME strongly recommended.

Response

200

base_sso_urlstring

default_plan_uuidstring

installation_endpointstring

is_in_betaboolean

public_keystring

required_fieldsstring[]

scopesstring[]

supported_localesstring[]

uninstallation_endpointstring

updowngrade_installation_endpointstring

uuidstring

visible_to_clientsboolean

window_typestring

Example response

{
  "app_plans": [
    {
      "plan_profiles": {
        "en": {
          "plan_features": [
            "My first feature"
          ],
          "plan_name": "First",
          "plan_subtitle": "Start..."
        }
      },
      "plan_type": "free",
      "plan_uuid": "332653a3-df51-45ce-a873-fbb0b1ccb49f"
    }
  ],
  "app_profile": {
    "en": {
      "app_logo": "https://temporary.com/imageLogo.png",
      "app_long_description": "This app can do this a that",
      "app_name": "Display name",
      "app_screenshots": [
        {
          "alt_text": "Description of image above",
          "image_url": "https://temporary.com/image.jpg"
        }
      ],
      "app_short_description": "A short description goes here.",
      "privacy_note_page": "https://temporary.com/privacy_en",
      "public_page": "https://temporary.com/ourproduct",
      "terms_of_service_page": "https://temporary.com/terms_en"
    }
  },
  "base_sso_url": "https://temporary.com/sso",
  "default_plan_uuid": "332653a3-df51-45ce-a873-fbb0b1ccb49f",
  "installation_endpoint": "https://temporary.com/endpoint",
  "public_key": "MIIBI...",
  "required_fields": [
    "EMAIL"
  ],
  "scopes": [
    "GET_WEBSITE"
  ],
  "supported_locales": [
    "en"
  ],
  "uninstallation_endpoint": "https://temporary.com/endpoint",
  "updowngrade_installation_endpoint": "https://temporary.com/endpoint",
  "uuid": "2257f749-03a7-45c2-9e8a-ae5f5e6e072c",
  "visible_to_clients": true,
  "webhooks": {
    "endpoint": "https://temporary.com/endpoint",
    "events": [
      "CONTENT_LIB_CHANGED"
    ]
  },
  "window_type": "IFRAME|NEW_TAB",
  "wl_app_profile": {
    "en": {
      "app_logo": "https://temporary.com/imageLogo.png",
      "app_long_description": "This app can do this a that",
      "app_name": "White Labeled display name",
      "app_screenshots": [
        {
          "alt_text": "Description of image above",
          "image_url": "https://temporary.com/image.jpg"
        }
      ],
      "app_short_description": "A short description goes here."
    }
  }
}