API Reference

Create a new member of an organization

post
https://trac-demo.stage.pebble.cloud/api/v1/orgs//members

Create a new member, providing at least the required mandatory data.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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
required

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
required
date
string
required

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

Responses

Updated 10 days ago

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

Updated 10 days ago