Modify a browser-specific payload configuration

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Updates an add-on payload's add-ons, policies, and native messaging hosts. Published profiles cannot be updated.

Request URL

https://{serverurl}/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads/{payload_id}

Scope

DesktopCentralCloud.BrowserManager.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

payload_idstringMandatory

Payload ID from Get Add-On Management Profile response (config_data_item_id field)

addon_idstringMandatory

Add-On Management Profile ID from List Add-On Management Profiles response (manage_addon_id field)

- Request Body

JSON body with updated payload configuration data

application/json
JSON Object

Add-on payload. Pick a browser from the dropdown

Hide Sub-Attributes
addon_payloadsOptional

Browser-specific payload

Show Sub-Attributes
oneOf

Examples

Google Chrome
Google Chrome -- Add-on payload for Google Chrome (browser_type=1, payload_type=64125)
Mozilla Firefox -- Add-on payload for Mozilla Firefox (browser_type=2, payload_type=64127). No permissions/native_hosts/pinned_addons
Microsoft Edge -- Add-on payload for Microsoft Edge (browser_type=5, payload_type=64907)
Ulaa -- Add-on payload for Ulaa (browser_type=31, payload_type=64459); shares the Chrome web store
Other Chromium -- Add-on payload for other Chromium browsers (browser_type=1024, payload_type=64409); includes applicable_browsers
Internet Explorer -- Add-on payload for Internet Explorer (browser_type=3, payload_type=64126). IE-specific policies; no permissions/native_hosts/pinned_addons

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomains/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

Sample Request Body - Google Chrome

Modify Chrome payload

Copied!
  {
    "addon_payloads": {
      "restrict_permissions": 1,
      "payload_type": 64125,
      "runtime_addons": [],
      "restrict_domains": -1,
      "pinned_addons": [
        "30"
      ],
      "permissions": [
        "10"
      ],
      "browser_type": 1,
      "policies": {
        "disable_user_extensions": "-1"
      },
      "add_ons": [
        {
          "binary_id": "30"
        }
      ],
      "restrict_addons": "1",
      "native_hosts": {
        "native_permission": "-1",
        "native_ids": []
      },
      "install_addons": [
        "30"
      ]
    }
  }
                
Show full

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomains/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

Sample Request Body - Mozilla Firefox

Modify Firefox payload

Copied!
  {
    "addon_payloads": {
      "payload_type": 64127,
      "restrict_domains": -1,
      "browser_type": 2,
      "policies": {
        "disable_user_extensions": "-1"
      },
      "add_ons": [
        {
          "binary_id": "13"
        }
      ],
      "restrict_addons": "1",
      "install_addons": []
    }
  }
                
Show full

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomains/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

Sample Request Body - Microsoft Edge

Modify Edge payload

Copied!
  {
    "addon_payloads": {
      "restrict_permissions": 1,
      "payload_type": 64907,
      "runtime_addons": [],
      "restrict_domains": -1,
      "pinned_addons": [],
      "permissions": [],
      "browser_type": 5,
      "policies": {
        "disable_user_extensions": "-1"
      },
      "add_ons": [],
      "restrict_addons": "1",
      "native_hosts": {
        "native_permission": "-1",
        "native_ids": []
      },
      "install_addons": []
    }
  }
                
Show full

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomains/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

Sample Request Body - Ulaa

Modify Ulaa payload

Copied!
  {
    "addon_payloads": {
      "restrict_permissions": 1,
      "payload_type": 64459,
      "runtime_addons": [],
      "restrict_domains": -1,
      "pinned_addons": [
        "30"
      ],
      "permissions": [],
      "browser_type": 31,
      "policies": {
        "disable_user_extensions": "-1"
      },
      "add_ons": [
        {
          "binary_id": "30"
        }
      ],
      "restrict_addons": "1",
      "native_hosts": {
        "native_permission": "-1",
        "native_ids": []
      }
    }
  }
                
Show full

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomains/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

Sample Request Body - Other Chromium

Modify Chromium payload

Copied!
  {
    "addon_payloads": {
      "restrict_permissions": 1,
      "payload_type": 64409,
      "runtime_addons": [],
      "restrict_domains": -1,
      "pinned_addons": [],
      "permissions": [],
      "browser_type": 1024,
      "policies": {
        "disable_user_extensions": "-1"
      },
      "add_ons": [],
      "restrict_addons": "1",
      "native_hosts": {
        "native_permission": "-1",
        "native_ids": []
      }
    }
  }
                
Show full

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomains/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

Sample Request Body - Internet Explorer

Modify IE payload

Copied!
  {
    "addon_payloads": {
      "restrict_permissions": -1,
      "payload_type": 64126,
      "restrict_domains": -1,
      "permissions": [],
      "browser_type": 3,
      "policies": {
        "turn_off_blocking_outdated_addon": "1",
        "restrict_activex": "0",
        "remove_run_this_time": "0",
        "enable_extensions": "1"
      },
      "add_ons": [],
      "restrict_addons": "0"
    }
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payloads

Modified payload configurations. Schema branches by target browser

Show Sub-Attributes
oneOf

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Error code indicating insufficient permissions

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 404

Response Body - application/json
JSON Object
Hide Sub-Attributes
errormsgstring

Message indicating the requested resource was not found

- HTTP code 409

Response Body - application/json
JSON Object
Hide Sub-Attributes
errormsgstring

Message indicating a published profile cannot be modified

- HTTP code 429

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Rate limit error code returned when the API call reached threshold

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json
JSON Object
Hide Sub-Attributes
errormsgstring

Message describing the internal server error

Possible Response Codes

200HTTP code
401HTTP code
403HTTP code
404HTTP code
409HTTP code
429HTTP code
500HTTP code

Response Examples

Sample Response: HTTP 200 - Google Chrome

Chrome payload modified

Copied!
  {
    "payloads": [
      {
        "restrict_permissions": "1",
        "payload_type": "64125",
        "restrict_domains": "-1",
        "binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "payload_id": "1164",
        "permissions": [
          {
            "name": "Context menu",
            "id": "10"
          }
        ],
        "pinned_binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "browser_type": "1",
        "policies": {
          "disable_user_extensions": "1",
          "allow_flash": "-1"
        },
        "restrict_addons": "1",
        "native_hosts": {
          "native_permission": "-1",
          "native_details": []
        },
        "config_label": "MANAGE_CHROME_ADDONS"
      }
    ]
  }
                
Show full

Sample Response: HTTP 200 - Mozilla Firefox

Firefox payload modified

Copied!
  {
    "payloads": [
      {
        "payload_type": "64127",
        "restrict_domains": "-1",
        "binaries_details": [
          {
            "browser_type": "2",
            "name": "System theme — auto",
            "binary_id": "13",
            "id": "default-theme@mozilla.org"
          }
        ],
        "payload_id": "1171",
        "pinned_binaries_details": [],
        "browser_type": "2",
        "policies": {
          "disable_user_extensions": "1"
        },
        "restrict_addons": "1",
        "config_label": "MANAGE_FIREFOX_ADDONS"
      }
    ]
  }
                
Show full

Sample Response: HTTP 200 - Microsoft Edge

Edge payload modified

Copied!
  {
    "payloads": [
      {
        "restrict_permissions": "1",
        "payload_type": "64907",
        "restrict_domains": "-1",
        "binaries_details": [],
        "payload_id": "1172",
        "permissions": [
          {
            "name": "Context menu",
            "id": "10"
          }
        ],
        "pinned_binaries_details": [],
        "browser_type": "5",
        "policies": {
          "disable_user_extensions": "1",
          "allow_flash": "-1"
        },
        "restrict_addons": "1",
        "native_hosts": {
          "native_permission": "-1",
          "native_details": []
        },
        "config_label": "CHROMIUM_EDGE_ADDONS_PAYLOAD"
      }
    ]
  }
                
Show full

Sample Response: HTTP 200 - Ulaa

Ulaa payload modified

Copied!
  {
    "payloads": [
      {
        "restrict_permissions": "1",
        "payload_type": "64459",
        "restrict_domains": "-1",
        "binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "payload_id": "1173",
        "permissions": [
          {
            "name": "Context menu",
            "id": "10"
          }
        ],
        "pinned_binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "browser_type": "31",
        "policies": {
          "disable_user_extensions": "1",
          "allow_flash": "-1"
        },
        "restrict_addons": "1",
        "native_hosts": {
          "native_permission": "-1",
          "native_details": []
        },
        "config_label": "MANAGE_ULAA_ADDONS"
      }
    ]
  }
                
Show full

Sample Response: HTTP 200 - Other Chromium

Chromium payload modified

Copied!
  {
    "payloads": [
      {
        "restrict_permissions": "1",
        "payload_type": "64409",
        "restrict_domains": "-1",
        "payload_id": "1174",
        "browser_type": "1024",
        "policies": {
          "disable_user_extensions": "1",
          "allow_flash": "-1"
        },
        "applicable_browsers": [],
        "binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "permissions": [
          {
            "name": "Context menu",
            "id": "10"
          }
        ],
        "pinned_binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "restrict_addons": "1",
        "native_hosts": {
          "native_permission": "-1",
          "native_details": []
        },
        "config_label": "CHROMIUM_ADDONS_PAYLOAD"
      }
    ]
  }
                
Show full

Sample Response: HTTP 200 - Internet Explorer

IE payload modified

Copied!
  {
    "payloads": [
      {
        "payload_type": "64126",
        "restrict_domains": "-1",
        "binaries_details": [],
        "payload_id": "1175",
        "pinned_binaries_details": [],
        "browser_type": "3",
        "policies": {
          "turn_off_blocking_outdated_addon": "1",
          "enable_extension": "1",
          "restrict_activex": "0",
          "remove_run_this_time": "0"
        },
        "restrict_addons": "0",
        "config_label": "MANAGE_IE_ADDONS"
      }
    ]
  }
                
Show full

Sample Response: HTTP 401

Unauthorized

Copied!
  {
    "errorCode": "UNAUTHORIZED",
    "errorMsg": "You are not authorized to perform this action"
  }
                
Show full

Sample Response: HTTP 403

Insufficient permissions

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "User does not have permission to perform this operation"
  }
                
Show full

Sample Response: HTTP 404

Profile or payload not found

Copied!
  {
    "errormsg": "Payload not found"
  }
                
Show full

Sample Response: HTTP 409

Cannot modify published profile

Copied!
  {
    "errormsg": "Cannot modify published policy. Clone the policy and retry"
  }
                
Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!
  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "Too many requests. Please try again after 5 minutes"
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "errormsg": "Internal Server error, Please try again in a moment."
  }
                
Show full

Duration: 1 minute | Threshold: 60 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.