POST api/v1/Teams

Create a new team

Request Information

URI Parameters

NameDescriptionTypeAdditional information
fields

Use this to only return the data fields you're interested in. Field names not found are ignored and no error is thrown. If no fields are found then the full object is returned.

 Collection of string

None.
suppressResponseCodes

Some applications do wonky things if error codes are used. Use this to force 200s to always return.

 boolean

None.
APIKey

This is your unique key that identifies you as the developer of this app. Required for all calls.

 string

None.
APIToken

This is the user's session token generated when you authenticate the user

 string

None.

Body Parameters

Create object

TeamCreateFields
NameDescriptionTypeAdditional information
Name

Name of the team

 string

None.
OUID

OU to put the team in. If this field is null ensure that the ParentTeamID field is set and this field will be populated by the OU ID of its assigned parent.

 globally unique identifier

None.
ParentTeamID

ID of the parent team. If the OUID field is null then the OU ID of the parent team provided by this field will be used to fill that field.

 globally unique identifier

None.
LeaderID

ID of the team leader

 globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "OUID": "8d1af95b-b2ef-4e7a-b2da-4f88c1baeb82",
  "ParentTeamID": "0201f250-4b37-4c88-9ad5-f2ddd874b5af",
  "LeaderID": "64b97d68-1fe8-4bb8-9dc9-ae1a9a089156"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Team
NameDescriptionTypeAdditional information
ID

Team's ID

 globally unique identifier

None.
Name

Team's name

 string

None.
OUName

Team's OU's name

 string

None.
OUID

Team's OU ID

 globally unique identifier

None.
LeaderFName

Team's leader's first name

 string

None.
LeaderLName

Team's leader's last name

 string

None.
LeaderID

Team's lead user ID

 globally unique identifier

None.
ParentIDs

Parent IDs of this team

 Collection of globally unique identifier

None.

Response Formats

application/json, text/json

Sample: 
{
  "ID": "c8d335f5-8b26-474e-af54-d0205f2458dd",
  "Name": "sample string 2",
  "OUName": "sample string 3",
  "OUID": "61e9348c-10a3-4a74-806f-b14bd57e574d",
  "LeaderFName": "sample string 5",
  "LeaderLName": "sample string 6",
  "LeaderID": "29f10219-d906-4294-8316-fad119ebc07f",
  "ParentIDs": [
    "6b34ca36-2fa8-4c04-960e-3e4365949134",
    "dffc6497-67a4-4738-be54-e9bf9c6aba72"
  ]
}