Update a team

patch/v1/public/teams/{teamId}

Path parameters

teamIdstring required

Request body

namesobject

the name of the team in various locales. Accepted locales are en, fr, es

divisionstring

If specified, the team will be linked to this division. The value can be either a division code or a division uid.

locationsstring[]

If specified, the team will be linked the locations. The value can be either location codes or location uids.

skillsstring[]

If specified, the team will be linked the skills (positions). The value can be either skill codes or skill uids.

timeZonestring

If specified, the team time zone. The possible values can be seen here https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified to company time zone will be used. The team time zone is used to preset the time zone of shifts created on the this team.

codestring

A human readable ID that can be use has an ID for other API calls. The code is also used to map a team to an external system structural element.

externalIdstring

A unique UID or a human readable ID that can be use has an ID for other API calls. The externalId can also be used to map a team to an external system structural element.

customobject

To set custom fields to a team. You can pass a json objet where the values are string. Will merge with previous values.

Example request

{
  "names": {
    "en": "customer service",
    "fr": "service client"
  },
  "timeZone": "America/New_York",
  "custom": {
    "field1": "value1",
    "field2": "value2"
  }
}

Response

uidstring required

unique team id

status'active' | 'deleted' required

Team status

namesobject required

Multilingual team name as a map indexed by locale ("en" or "fr")

codestring

The team code. The code is often used as a mapping value between Evolia and an external system

externalIdstring

The unique team externalId. The externalId is often used as a mapping value between Evolia and an external system

locationIdsstring[] required

Array of location UIDs linked to the team

skillIdsstring[] required

Array of skill UIDs linked to the team

customobject nullable

An optional object of custom properties. Current implementation only support string values

Example response

{
  "names": {
    "en": "customer service",
    "fr": "service client"
  },
  "custom": {
    "key1": "value1",
    "key2": "value2"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.