Chat Widget

Chat Widget API

Documentación de la API de Chat Widget

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

Endpoints

• GET /chat-widget/list — Listar Chat Widgets
• GET /chat-widget/data/{locationId}/{id} — Obtener widget de chat
• PUT /chat-widget/data/{locationId}/{id} — Actualizar widget de chat
• PATCH /chat-widget/data/{locationId}/{id} — Patch Chat Widget
• GET /chat-widget/public/config/{id} — Obtener Widget Config
• DELETE /chat-widget/{locationId}/{id} — Eliminar widget de chat
• POST /chat-widget/clone — Clone Chat Widget
• POST /chat-widget/ — Crear widget de chat

GET /chat-widget/list

Listar Chat Widgets Returns chat widgets for the sub-account with pagination and optional filters.

Scopes requeridos: chat-widget.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Id de The location - offset (query, string) (requerido) — Offset - limit (query, string) (requerido) — Limit - chatType (query, string) — The type of chat widget. Supports normal ChatType values, plus the virtual umbrella "webChat" (maps to facebookChat/emailChat/instagramChat/waChat). - excludeChatType (query, string) — The type of chat widget - voiceAiAgentId (query, string) — Id de The voice AI agent - allInOneChatTypes (query, string) — All-in-one chat type to filter by. Only applies when chatType is "allInOneChat". Supports normal ChatType values plus the virtual umbrella "webChat" (maps to facebookChat/emailChat/instagramChat/waChat).

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

GET /chat-widget/data/{locationId}/{id}

Obtener widget de chat Returns a single chat widget by Id.

Scopes requeridos: chat-widget.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) — Id de The chat widget - locationId (path, string) (requerido) — Id de The location

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

PUT /chat-widget/data/{locationId}/{id}

Actualizar widget de chat Full update of a chat widget resource.

Scopes requeridos: chat-widget.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) — Id de The chat widget - locationId (path, string) (requerido) — Id de The location

Cuerpo de la peticion (application/json): - versión — number — Versión - chatType — string — Chat type - name — string — Name - default — boolean — Default - settings — — Settings

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

PATCH /chat-widget/data/{locationId}/{id}

Patch Chat Widget Partial update of a chat widget resource.

Scopes requeridos: chat-widget.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) — Id de The chat widget - locationId (path, string) (requerido) — Id de The location

Cuerpo de la peticion (application/json): - versión — number — Versión - chatType — string — Chat type - name — string — Name - default — boolean — Default - settings — — Settings

Respuestas: - 200 — Exitosa - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

GET /chat-widget/public/config/{id}

Obtener Widget Config Returns widget configuration by Id.

Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) — Id de The chat widget - versión (query, string) —

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

DELETE /chat-widget/{locationId}/{id}

Eliminar widget de chat Soft-deletes a chat widget. If it was the default, another widget may be promoted.

Scopes requeridos: chat-widget.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - id (path, string) (requerido) — Id de The chat widget - locationId (path, string) (requerido) — Id de The location

Respuestas: - 200 - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

POST /chat-widget/clone

Clone Chat Widget Creates a copy of an existing chat widget in the same sub-account.

Scopes requeridos: chat-widget.write

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

Cuerpo de la peticion (application/json): - locationId (requerido) — string — locationId - chatWidgetId (requerido) — string — chat widget Id - name — string — Name for the cloned widget

Respuestas: - 201 — Creado - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 404 — No encontrado - 422 — Entidad no procesable

POST /chat-widget/

Crear widget de chat Creates a new chat widget for the given sub-account.

Scopes requeridos: chat-widget.write

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

Cuerpo de la peticion (application/json): - versión (requerido) — number — Versión - chatType (requerido) — string — Chat type - name (requerido) — string — Name - locationId (requerido) — string — Location Id - deleted — boolean — Deleted - default — boolean — Default - settings — — Settings

Respuestas: - 201 — Creado - 400 — Peticion invalida - 401 — No autorizado - 403 — El token no tiene acceso a esta sede - 422 — Entidad no procesable