Team Members

Team members are people in your team who can access, edit or being setted into schedules. On this page, we’ll dive into the different team member endpoints you can use to manage your team members programmatically. We'll look at how to upload and update team members.

The Team Member model

The team member model contains all the information about your team members, including the name, structure node id, email, role and employee ID.

Properties

Name
employeeID
Type
string
Description
Unique identifier for the team member.
Name
email
Type
string
Description
Unique email address of the team member.
Name
name
Type
string
Description
The full name of the team member.
Name
roleCode
Type
string | null
Description
The code of the role of the team member.
Name
parentKey
Type
string | null
Description
The key of the team member's structure node.

POST/integrations/teamMembers

Update all team members

This endpoint allows you to upload all members of your team. It replaces all the existing team members with uploaded ones. See the code examples for how to upload your Team Members through ProShedule API.

Required attributes

Name
body
Type
Array<teamMember>
Description
An array of team member objects.

Request

POST

/integrations/teamMembers

curl https://api.proschedule.ambraisoft.com/integrations/teamMembers \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer {token}" \
  --data-raw '[
    {
      "employeeID": "some employeeID...",
      "email": "example@email.com",
      "name": "Example Employee",
      "roleCode": 1,
      "parentKey": "Market_1"
    }
  ]'

Response

  {
      "message": "1 team member(s) uploaded",
      "status": 200
  }