Skip to main content

Enable Change Details Writeback From My School Portal To iSAMS

Learn how to enable iSAMS API writeback so approved Change Details Requests in My School Portal can automatically update data in iSAMS.

Written by Cristina Gruita
Updated today

When Change Details Requests are enabled with iSAMS API writeback, approved changes made by guardians or students in My School Portal (MSP) can automatically update the corresponding records in iSAMS.

This reduces manual data entry and helps keep your MIS and portal in sync.


1. Prerequisites And Support Tickets

To enable writeback, you need to involve both iSAMS and My School Portal support.

Step 1 – Request REST API credentials from iSAMS

  1. Raise a ticket with iSAMS support.

  2. Ask for REST API credentials that will allow My School Portal to write back user data into iSAMS.

  3. Keep the credentials secure; you will pass them on to the MSP team via a secure support channel.

Step 2 – Raise a ticket with My School Portal support

Once you have the REST API credentials:

  1. Raise a support ticket with the My School Portal team.

  2. State that you want to enable iSAMS API writeback for Change Details Requests.

  3. Include the REST API credentials you received from iSAMS (following any security guidance from both vendors).

The MSP support team will then configure writeback for your site using those credentials.


2. Guardian Details That Can Be Written Back

When writeback is enabled, MSP can update the following guardian fields in iSAMS:

  • title.

  • forename.

  • surname.

  • email Address.

  • telephone Number.

  • mobile Number.

  • address1.

  • address2.

  • address3.

  • town.

  • county.

  • postcode.

  • country.

  • emergency Notes.

These are populated from the Change Details Requests submitted and approved via MSP.


Joint Contacts Behaviour

If you are using joint contacts in your MIS:

  • MSP can identify each guardian within the joint contact.

    If one of the users in the joint contact changes their email address in the portal and this is written back:

  • The writeback will update the email address for both guardians in the MIS record.

Keep this in mind when reviewing and approving email change requests for joint contacts.


3. Student Details That Can Be Written Back

For students, MSP can write back the following fields to iSAMS:

  • forename / preferred Name.

  • middle Names.

  • surname.

  • dob (date of birth).

  • gender.

  • mobile Number.

These fields are updated when a Change Details Request for a student is submitted in MSP, approved, and successfully written back via the iSAMS API.

Did this answer your question?