Sign in
Public
Skills

Update a position (skill)

patch/v1/public/skills/{skillId}

Path parameters

skillIdstring required

Request body

namesobject

The name of the skill (position) in various locales. Accepted locales are en, fr, es

codestring

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

abbrevstring

an abbreviation text, used in various place in the application where space is tight. Like on shifts of the schedule view.

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 position to an external system structural element.

colorIndexnumber

An index from 0 to 19 matching the skill color palette. Check the create position screen in Evolia settings.

enableClockingboolean

When true, shifts linked to this skill (position) can be clocked in and out by employees.

dontAutoPropagateboolean

Only relevant for skills with enableClocking set to false. Set this to true to prevent automatic timesheet filling using scheduled hours.

customobject

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

Example request

{
  "names": {
    "en": "cook",
    "fr": "cuisinier"
  },
  "abbrev": "HQ",
  "colorIndex": 16,
  "custom": {
    "field1": "value1",
    "field2": "value2"
  }
}

Response

uidstring required

unique skill id

status'active' | 'deleted' required

Skill status

namesobject required

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

abbrevstring

Represents the abbreviation of the skill

codestring

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

externalIdstring

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

colorIndexnumber required

An index from 0 to 19 matching the skill color palette. Check the create position screen in Evolia settings.

customobject nullable

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

Example response

{
  "names": {
    "en": "cook",
    "fr": "cuisinier"
  },
  "custom": {
    "key1": "value1",
    "key2": "value2"
  }
}

Changes

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