How to update a student record with Postman

You can update student records via OpenApply's API using a PATCH request with a JSON body.  

We recommend downloading our Postman collection of OpenApply endpoints, which includes full annotation and sample responses for a quick way to get started with the API.  For help to set up authentication see: OpenApply v3 API Authentication

In OpenApply the endpoint to update a student is: 

PATCH https://{{subdomain}}.openapply.{{tld}}/api/v3/students/{{id}}

For example, when using my test site, f1.openapply.com, and student with id: 2454125

PATCH https://f1.openapply.com/api/v3/students/2454125

You'll need to use the OpenApply ID rather than your Student ID, which you can find in:

GET https://{{subdomain}}.openapply.{{tld}}/api/v3/students

Please note this endpoint is paginated with 50 results per page by default.

Enter the OpenApply ID in the parameters of the patch request, e.g.

Enter the key or keys that you would like to update in the body of the request in JSON format.  Since this is a PATCH request, you only need to send the keys that you wish to update. The keys that can be updated for a student are: 

• First name
 (first_name)
• Last Name
 (last_name)
• Other Name
 (other_name)
• Preferred Name
 (preferred_name)
• Email
 (email)
• Student ID
 (student_id)
• Status (status)
• Address
 (address)
• Address 2
 (address_ii)
• City
 (city)
• State
 (state)
• Postal Code
 (postal_code)
• Enrollment Year
 (enrolment_year)
• Birth Date
 (birth_date)

When you send your request you will see the update in the response received. The response will include additional keys (such as "full_address") which are combinations or summaries of other fields, and cannot be updated directly.

Please note:  If the update fails, the changes requested will be skipped. You will still receive a Status 200 response. 

Possible reasons why this could occur are that the key specified doesn't match one of the keys exactly, or the student entity has not been declared.