← Volver al índice de esquemas

UserRetryPolicyResponse

Propiedades

CampoTipoDescripción
dataobjectPayload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`).
typestring
attributesobjectPolítica de reintentos guardada de la cuenta: activación, límite, intervalo y resultados elegibles. Desactivada o sin configurar, trae `enabled=false`, `max_retries=0`, `interval_seconds=0` y `outcomes` vacío.
enabledboolean`true` cuando el ciclo de reintentos está activo. Si es `false`, los demás campos pueden ser ignorados.
max_retriesintegerNúmero máximo de reintentos automáticos. Una vez alcanzado, el ciclo pasa al estado terminal `exhausted`.
interval_secondsintegerSegundos de espera entre cada reintento. Valores válidos: 300–86400 (5 min a 24h).
outcomesarrayResultados que originan un reintento. De forma predeterminada son `not_found`, `cep_unavailable` y `error`; la combinación `["not_found", "cep_unavailable"]` excluye `error`.
metaobjectMetadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.
versionstringVersión de la API que procesó la petición.
api_versionstringVersión del prefijo de ruta de la API (ej. `v1`).
request_idstringIdentificador único de la petición (hex).
datetimeobjectDescriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` del cuerpo de los webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin releer el spec.
timezone*stringSiempre `UTC`: La zona canónica para cada campo datetime del cuerpo.
format*stringSiempre `ISO 8601`: Sufijo `Z` explícito en cada datetime.
linksobjectEnlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Usado en operaciones

  • GET /v1/users/me/retry-policy