Skip to main content
El vocabulario que usa Yampi en la API de cuenta. Cuando leas un endpoint, estas piezas son el contexto.

​
Cuenta

Una cuenta es la inmobiliaria: nombre, slug, estado (active por defecto) y configuración (locale, límites, features, calendario, Livia…). Casi todos los recursos cuelgan de /api/v1/accounts/{account_id}/....

​
Usuario y membresía

Un usuario puede estar en varias cuentas. La membresía es AccountUser: En el perfil (GET /api/v1/profile) cada cuenta trae role, suite_role y permissions.

​
Suites y permisos

Un administrador recibe el permiso administrator. Los requerimientos los puede trabajar un agente o un administrador según la policy — no son “de la suite Servicio”. suite_role y custom_role no se combinan: la membresía no admite los dos a la vez.

​
Token de acceso

Cada usuario (y cada bot) tiene un AccessToken. Lo envías en api_access_token. Detalle en Empezar aquí.

​
Livia y Livia Desk

Son dos superficies distintas:
  • Livia — asistentes en bandejas; hablan con el cliente (guía).
  • Livia Desk — copiloto interno del agente (copilot_threads / copilot_messages); propone y el humano confirma (guía).
El detalle HTTP está en la pestaña API.

​
Mapa del dominio

La identidad del firmante (IdentidApp) no es un recurso account-scoped de esta API: el flujo público está en /s/{slug}/identity.
El catálogo HTTP (método, path, body, respuestas) está en la pestaña API. Aquí solo fijamos el modelo.