Update a member of an organization

put

https://trac-demo.stage.pebble.cloud/api/v1/orgs/{org_id}/members/{member_id}

Replaces data held on a member.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

org_id

string

required

member_id

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.

misSource

string

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

isActive

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.

displayName

string

dateOfBirth

date

memberType

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

if-unmodified-since

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

400Bad Request

401Requires authentication

403Forbidden

404Resource not found

409Conflict

412Precondition failed