Update a member of an organization

Replaces data held on a member.

You must provide the If-Unmodified-Since header. See Optimistic Concurrency Control

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params

A member of an organization or organizational unit. For schools this might be a pupil or a member of staff. Represents an actual real world individual who has a relationship with the organization.

string

The name of the MIS system that the data of this member was pulled from (e.g. SIMS, Arbor, etc.)

boolean

Whether this is an active member in the system. Used to indicate a "soft delete"

tags
object

Tags that can be used to categorize the member.

externalIds
object

External IDs associated with the member.

string
date
string

The 'person type' that this member is. Examples are 'pupil', 'staff', 'visitor', 'relation', etc

mis
object

Data from school MIS systems.

parentPay
object

For Parent Pay specific data

May be used to store additional parentpay data which is only later accessible in reporting.

till
object

Data from goodtill

tali
object

Data from tali

Headers
date-time
required

This header is used in all PUT methods to implement Optimistic Concurrency Control. You must specify the date and time of the version of the resource that you wish to modify. This will be checked on the server and, if the resource has been updated subsequently, the update will be refused with a 412 Precondition Failed.

See RFC7232.

Note: While the above reference gives examples of using HTTP-Date format for the date in the header, the date-time ISO 8601 format should be used in our case (YYYY-MM-DDTHH:MM:SS), e.g.: "If-Unmodified-Since": "2022-02-07T16:18:33"

Responses
204

Updated

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json