HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Actualizar metadata de un Beneficiary

Fusiona claves en la metadata de un Beneficiary sin reemplazarla por completo.

Las claves enviadas se escriben sobre la metadata existente: las que ya estaban con otro valor se sobrescriben y las que no vienen en la solicitud se conservan. No hay forma de borrar una clave por esta vía.

El campo metadata es obligatorio. Cada clave se escribe como una ruta anidada, así que una clave vacía, que empiece con $ o que contenga un punto se rechaza con 422.

Límite de tasa: 1000 solicitudes por hora. Al superarlo, la API responde 429. Ver Límites de tasa.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Identificador del Beneficiary.

Body Params

Additive metadata update: the provided keys are merged into the beneficiary's existing metadata (top-level), overwriting collisions and preserving the rest.

metadata is required — a missing field is a client error, not an empty patch. Keys are written as nested metadata.<key> paths for an atomic per-key merge, so a key must be non-empty and may not contain . or a NUL character or start with $ (those are MongoDB path/operator syntax and would otherwise fail the update at write time).

metadata
object
required

Claves que se fusionan en la metadata del Beneficiary.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json