v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB
User Management

Update a Student Loan

This API updates user records with accurate student loan account numbers and correct billing addresses to ensure proper payments to institutions.

patch/v1/users/{userId}/studentLoans/{studentLoanId}

Path parameters

userIdstring required

Spinwheel userId to identify a user (one of userId or extUserId is required).

studentLoanIdstring required

Spinwheel student loan Id associated with the user.

Request body

accountNumberstring

Example request

{
  "creditor": {
    "billingAddress": {
      "addressLine1": "123 Main Street",
      "addressLine2": "Unit 208",
      "city": "San Francisco",
      "state": "CA",
      "zip": "90211",
      "zipExtension": "1234"
    }
  }
}

Response

Success