Skip to main content
Updates an existing custom menu for a given company. Requires authentication and proper permissions. 
PUT https://services.leadconnectorhq.com/custom-menus/{customMenuId}

​
Autorización

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticación.
​
Version
string
default:"2021-07-28"
required
Versión de la API.

​
Path parameters

​
customMenuId
string
default:"62e589c1-c456-47e1-a9a7-cb8900014311"
required
ID of the custom menu to update

​
Body

​
title
string
default:"Custom Menu"
Title of the custom menu
​
url
string
default:"https://custom-menus.com/"
URL of the custom menu
​
icon
object
Icon information for the custom menu
​
showOnCompany
boolean
default:"True"
Whether the menu must be displayed on the agency’s level
​
showOnLocation
boolean
default:"True"
Whether the menu must be displayed for accounts level
​
showToAllLocations
boolean
default:"True"
Whether the menu must be displayed to all accounts
​
openMode
string
Mode for opening the menu link Posibles valores: ‘iframe’, ‘new_tab’, ‘current_tab’
​
locations
string[]
List of account IDs where the menu should be shown. This list is applicable only when showOnLocation is true and showToAllLocations is false
​
userRole
string
Which user-roles should the menu be accessible to? Posibles valores: ‘all’, ‘admin’, ‘user’
​
allowCamera
boolean
default:"False"
Whether to allow camera access (only for iframe mode)
​
allowMicrophone
boolean
default:"False"
Whether to allow microphone access (only for iframe mode)

​
Respuestas

​
success
boolean
Status of update
​
customMenu
object
Updated custom menu link
{
  "success": true
}

{}

{}

​
Ejemplo

curl -X PUT 'https://services.leadconnectorhq.com/custom-menus/YOUR_customMenuId' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "Custom Menu",
  "url": "https://custom-menus.com/",
  "showOnCompany": true,
  "showOnLocation": true,
  "showToAllLocations": true,
  "openMode": "iframe",
  "locations": [
    "gfWreTIHL8pDbggBb7af",
    "67WreTIHL8pDbggBb7ty"
  ],
  "userRole": "all",
  "allowCamera": false,
  "allowMicrophone": false
}'

const response = await fetch('https://services.leadconnectorhq.com/custom-menus/YOUR_customMenuId', {
  method: 'PUT',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"title": "Custom Menu", "url": "https://custom-menus.com/", "showOnCompany": true, "showOnLocation": true, "showToAllLocations": true, "openMode": "iframe", "locations": ["gfWreTIHL8pDbggBb7af", "67WreTIHL8pDbggBb7ty"], "userRole": "all", "allowCamera": false, "allowMicrophone": false}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'PUT',
    'https://services.leadconnectorhq.com/custom-menus/YOUR_customMenuId',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"title": "Custom Menu", "url": "https://custom-menus.com/", "showOnCompany": true, "showOnLocation": true, "showToAllLocations": true, "openMode": "iframe", "locations": ["gfWreTIHL8pDbggBb7af", "67WreTIHL8pDbggBb7ty"], "userRole": "all", "allowCamera": false, "allowMicrophone": false},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/custom-menus/YOUR_customMenuId');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode({'title': 'Custom Menu', 'url': 'https://custom-menus.com/', 'showOnCompany': true, 'showOnLocation': true, 'showToAllLocations': true, 'openMode': 'iframe', 'locations': ['gfWreTIHL8pDbggBb7af', '67WreTIHL8pDbggBb7ty'], 'userRole': 'all', 'allowCamera': false, 'allowMicrophone': false}),
]);
$data = json_decode(curl_exec($ch), true);