---
title: "Save income guideline"
method: PUT
path: "/v2/book/{book_uuid}/income-guideline"
tags: ["Income"]
---

# Save income guideline

`PUT /v2/book/{book_uuid}/income-guideline`

This API lets you set or update the loan program or Government-Sponsored Enterprise (GSE) guideline for an Ocrolus <<glossary:Book>>. It ensures income calculations use the correct guideline (for example, Fannie Mae, Freddie Mac, FHA, VA, or USDA) and that the results are accurately reflected in the Ocrolus Dashboard for underwriting review. The most recent guideline is always used for income calculations by default.

You can use this API to:
- Set the income guideline immediately after the Book is created.
- Update the income guideline with a different guideline value later if the loan program changes. 

> 📘 Notes
> - A valid `book_uuid` is required.
> - Updated income calculations are reflected after processing is complete.

## Path parameters

- `book_uuid` string, uuid, required

## Query parameters

- `guideline` 'FANNIE_MAE' | 'FREDDIE_MAC' | 'FHA' | 'VA' | 'USDA' | 'CONVENTIONAL', required

## Response `200`

Success

- object
  - `response` object — Response object containing income guideline details.
    - `book_uuid` string, uuid — Unique identifier of Book for which the loan program or GSE guideline created or updated.
    - `income_guideline` 'FANNIE_MAE' | 'FREDDIE_MAC' | 'FHA' | 'VA' | 'USDA' | 'CONVENTIONAL' — Applied income guideline.
    - `staus` string — Indicates whether the income guideline was newly created for the Book or updated from a previous value.

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/ocrolus/apis/user-management.md) · [All operations](https://skmtc.net/ocrolus/apis/user-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ocrolus/user-management/revisions/3571ef602d13/schema)