Actualizar una lista

PATCH/v1/lists/{id}

Para desarrolladores

Descripción

Cambia el nombre, los canales o la descripción de una lista. Solo cambian los campos que se envían.

Autenticación

Authorizationbearer tokenheaderobligatorio

API key con scope list:write. Formato: Bearer <API_KEY>.

X-Instance-Slugstringheaderobligatorio

Identificador de su instancia. Ver Autenticación.

Request

Path params:

idintegerobligatorio

Identificador de la lista.

Body:

{
  "name": "Clientes abril",
  "description": null
}

namestring

Mismas reglas que al crear. No admite null.

channelstring[], enum: `mail | sms | wsp` | null

null deja la lista sin canales.

descriptionstring | null

null borra la descripción.

Un campo que no figura en esta tabla se rechaza con 422.

Response

200 OKDevuelve un objeto con los campos que siguen.

idintegersiempre presente

Identificador de la lista.

namestringsiempre presente

Nombre visible, único entre las listas vigentes.

channelstring[] | null

Vías por las que se le puede hablar a sus contactos: mail, sms, wsp.

descriptionstring | null

Descripción libre.

row_countintegersiempre presente

Filas de la lista según la última importación completada. 0 mientras no se haya importado nada.

created_atstring (date-time)siempre presente

Fecha de creación (ISO 8601, UTC).

updated_atstring (date-time)siempre presente

Fecha de la última modificación de la lista.

Errores

Código	Cuándo
404	La lista no existe o fue eliminada (list_not_found).
409	Ya existe otra lista vigente con el nombre nuevo (list_name_taken).
422	El body no es válido, o name viene en null.

Request

curl -X PATCH "https://$API_HOST/v1/lists/4" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG" \
-H "Content-Type: application/json" \
-d '{
  "name": "Clientes abril",
  "description": null
}'

Response

{
"id": 4,
"name": "Clientes marzo",
"channel": [
  "mail"
],
"description": null,
"row_count": 0,
"created_at": "2026-10-14T12:00:00Z",
"updated_at": "2026-10-14T12:00:00Z"
}