Documentación
superleads.mx
Documentación › Referencia de la API › Custom Menus

Custom Menus

Referencia de la API · ☕ 5 min de lectura
Actualizado el 19 Jun 2026

Custom menus API

Documentación de la API de Custom menus

Servidor base: https://services.leadconnectorhq.com

Endpoints

GET /custom-menus/{customMenuId}

Obtener Custom Menu Link Fetches a single custom menus based on id. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata

Scopes requeridos: custom-menu-link.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - customMenuId (path, string) (requerido) — Unique identifier of the custom menu

Respuestas: - 200 — Successfully retrieved custom menu. Returns a single custom menu object, potentially including its structure, items, and relevant metadata. - 400 — Bad Request. Invalid query parameters provided. - 401 — No autorizado - 403 — Forbidden. The client does not have necessary permissions to access custom menu. - 422 — Entidad no procesable

DELETE /custom-menus/{customMenuId}

Eliminar Custom Menu Link Removes a specific custom menu from the system. This operation requires authentication and proper permissions. The custom menu is identified by its unique Id, and the operation is performed within the context of a specific company.

Scopes requeridos: custom-menu-link.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - customMenuId (path, string) (requerido) — Id of the custom menu to delete

Respuestas: - 200 — Custom menu successfully deleted - 400 — Bad Request. Invalid parameters provided. - 401 — No autorizado - 403 — Forbidden. The client does not have necessary permissions to delete this custom menu. - 404 — Not Found. The specified custom menu does not exist or has already been deleted. - 422 — Entidad no procesable

PUT /custom-menus/{customMenuId}

Actualizar Custom Menu Link Updates an existing custom menu for a given company. Requires authentication and proper permissions.

Scopes requeridos: custom-menu-link.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - customMenuId (path, string) (requerido) — Id of the custom menu to update

Cuerpo de la peticion (application/json): - title — string — Title of the custom menu - url — string — URL of the custom menu - icon — — Icon information for the custom menu - showOnCompany — boolean — Whether the menu must be displayed on the agency's level - showOnLocation — boolean — Whether the menu must be displayed for sub-accounts level - showToAllLocations — boolean — Whether the menu must be displayed to all sub-accounts - openMode — string — Mode for opening the menu link - locations — array — List of sub-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? - allowCamera — boolean — Whether to allow camera access (only for iframe mode) - allowMicrophone — boolean — Whether to allow microphone access (only for iframe mode)

Respuestas: - 200 — Custom menu successfully updated - 400 — Bad Request - Invalid input - 401 — No autorizado - 403 — Forbidden - Insufficient permissions - 404 — Not Found - Custom menu or company not found - 422 — Entidad no procesable

GET /custom-menus/

Obtener Custom Menu Links Fetches a collection of custom menus based on specified criteria. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata. The response can be tailored using query parameters for filtering, sorting, and pagination.

Scopes requeridos: custom-menu-link.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) — Unique identifier of the location - skip (query, number) — Number of items to skip for pagination - limit (query, number) — Maximum number of items to return - query (query, string) — Search query to filter custom menus by name, supports partial || full names - showOnCompany (query, boolean) — Filter to show only agency-level menu links. When omitted, fetches both agency and sub-account menu links. Ignored if locationId is provided

Respuestas: - 200 — Successfully retrieved custom menus. Returns an array of custom menu objects, potentially including their structure, items, and relevant metadata. - 400 — Bad Request. Invalid query parameters provided. - 401 — No autorizado - 403 — Forbidden. The client does not have necessary permissions to access custom menus. - 422 — Entidad no procesable

POST /custom-menus/

Crear Custom Menu Link Creates a new custom menu for a company. Requires authentication and proper permissions. For Icon Usage Details please refer to https://doc.clickup.com/8631005/d/h/87cpx-243696/d60fa70db6b92b2

Scopes requeridos: custom-menu-link.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - title (requerido) — string — Title of the custom menu - url (requerido) — string — URL of the custom menu - icon (requerido) — — Icon information for the custom menu - showOnCompany (requerido) — boolean — Whether the menu must be displayed on the agency's level - showOnLocation (requerido) — boolean — Whether the menu must be displayed for sub-accounts level - showToAllLocations (requerido) — boolean — Whether the menu must be displayed to all sub-accounts - openMode (requerido) — string — Mode for opening the menu link - locations (requerido) — array — List of sub-account IDs where the menu should be shown. This list is applicable only when showOnLocation is true and showToAllLocations is false - userRole (requerido) — string — Which user-roles should the menu be accessible to? - allowCamera — boolean — Whether to allow camera access (only for iframe mode) - allowMicrophone — boolean — Whether to allow microphone access (only for iframe mode)

Respuestas: - 201 — Custom menu successfully created - 400 — Bad Request - Invalid input - 401 — No autorizado - 403 — Forbidden - Insufficient permissions - 422 — Entidad no procesable

Enter para abrir el primer resultado · Esc para cerrar