Saltar al contenido
Desarrolladores
3 min de lectura

Cuentas

Lista las cuentas a las que puedes llegar, lee una en detalle, cambia su estado y consulta quién tiene acceso.

Compartir artículo

Una cuenta es el espacio de trabajo al que pertenece todo lo demás: sus contactos, servicios, mensajes, números y usuarios. Casi todos los endpoints comienzan con un id de cuenta, así que este es el primer recurso que debes configurar bien.

Lista tus cuentas

Devuelve todas las cuentas activas que administras, con el detalle suficiente para mostrar un selector. Usa el id que aparece aquí en todas las demás llamadas.

GET /v0/account
curl https://api.furcata.com/v0/account \
  -H "Authorization: ******"
Response
[
  {
    "id": "acc_123",
    "uid": "acc_123",
    "alias": "acme",
    "name": "Acme Coffee",
    "country": "US",
    "language": "en",
    "domain": "example.com",
    "image": "https://example.com/logo.png",
    "status": "active",
    "timestamp": "2026-01-01T00:00:00.000Z"
  }
]

Lee una cuenta

El endpoint de detalle devuelve los mismos campos para una sola cuenta.

GET /v0/account/{account_id}
curl https://api.furcata.com/v0/account/acc_123 \
  -H "Authorization: ******"

Campos de la cuenta

  • id: el id de la cuenta. Úsalo en todas las rutas con alcance de cuenta.
  • uid: el identificador público de la cuenta.
  • alias: el nombre corto que se usa en URLs y referencias.
  • name: el nombre para mostrar.
  • country: código de país de dos letras.
  • language: idioma predeterminado de esta cuenta.
  • domain: el dominio web de la cuenta.
  • image: URL del logo o del avatar.
  • status: active, inactive, suspended, paused, draft o review.
  • timestamp: cuándo se creó la cuenta.

Cambia el estado de la cuenta

Los propietarios y administradores de una cuenta pueden moverla entre activa y en pausa. Esto solo cambia el registro; no se envía ningún mensaje y no se cobra nada.

POST /v0/account/{account_id}/status
curl -X POST https://api.furcata.com/v0/account/acc_123/status \
  -H "Authorization: ******" \
  -H "Content-Type: application/json" \
  -d '{"status": "paused"}'
Response
{
  "message": "Account status updated",
  "status": "paused"
}

status es obligatorio y acepta active, inactive, suspended, paused, draft o review. Los propietarios y administradores solo pueden alternar una cuenta que ya está activa entre activa y en pausa.

Lista los usuarios de una cuenta

Devuelve las personas vinculadas a la cuenta, con el rol que tiene cada una.

GET /v0/account/{account_id}/user
curl https://api.furcata.com/v0/account/acc_123/user \
  -H "Authorization: ******"

Cada usuario incluye id, name, firstName, lastName, abbr, username, email, phone, role, language, country, avatar, url, path, referrer, links, ads, backup, created y updated.

Errores

  • 401 cuando el token falta o no se acepta.
  • 403 cuando tu rol no permite la acción, por ejemplo un cambio de estado hecho por alguien que no es administrador.
  • 404 cuando la cuenta no existe o no puedes verla.

Siguientes pasos

Continúa con Contactos para crear una audiencia y luego con Mensajes para llegar a ella.