EVevolia
Public
Members

Update a member (employee)

Changed on
patch/v1/public/members/{memberId}

Request

Path parameters

memberIdstring required

Request body

fNameobject

Member First Name

lNameobject

Member Last Name

emailobject

Member email must be a valid email

phoneobject

Member phone

codeobject

Member code act as employee number. It is also used to uniquely identify a member during third parties system integration and during importation

hiringDateobject

Date in SQL format yyyy-mm-dd

hourlyWageobject

Default hourly wage used in all positions

maxHoursPerWeekobject

Maximum hours of work per week. Must be between 0 and 168 hours.

maxHoursPerPayPeriodobject

Maximum hours of work per pay period. Must be greater than 0

emailNotificationboolean

Accept email notifications

pushNotificationboolean

Accept push notifications

localestring

Evolia uses this locale when sending emails or sms to the member.Possible values are fr, en, es (french, english, spanish)

skillsobject

Skill code, name or uid

skillWagesstring

Hourly wage by skill. Use this format skillCode:amount. Elements must be separate by comma or semicolon

skillInitialExperienceHoursstring

Use this format skillCode:hourCount separate all entries with a comma or semicolon

teamsobject

Team code, name or uid

locationsobject

Location code, name or uid

typeCodestring

Employment status code

pinstring

Pin is used to clock in punch console. The value is a number represented as string

gender'M' | 'F' | 'X' | 'P'

Member gender. P mean "Prefer not to say"

customobject

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

birthdatestring

Date in SQL format yyyy-mm-dd

addressline1string

Home address (line 1)

addressline2string

Home address (line 2)

citystring

City of residence

statestring

State of residence

postalCodestring

Postal code / zip code of residence

countrystring

Country of residence

primaryEmergencyContactNamestring

Name of the person to contact in case of an emergency

primaryEmergencyContactPhonestring

Phone number of the person to contact in case of an emergency

primaryEmergencyContactNotestring

Note about the emergency contact

secondaryEmergencyContactNamestring

Name of the second person to contact in case of an emergency

secondaryEmergencyContactPhonestring

Phone number of the second person to contact in case of an emergency

secondaryEmergencyContactNotestring

Note about the second emergency contact

status'active' | 'inactive'

Member status, active or inactive

Example request

{
  "locale": "en",
  "skillWages": "S1:12.50,S2:15.25 OR S1:12.50;S2:15.25",
  "skillInitialExperienceHours": "S1:150,S2:250.5,S3:100 OR S1:150;S2:250.5;S3:100",
  "pin": "654321",
  "custom": {
    "field1": "value1",
    "field2": "value2"
  },
  "birthdate": "2001-01-31"
}

Response

uidstring required

Unique member id

createdAtstring required

Member creation date and time. In ISO-8601 format

updatedAtstring

Member last modification date and time. In ISO-8601 format

deactivatedAtstring

if the member status is inactive, the deactivation date in ISO-8601 format

status'active' | 'inactive' | 'deleted' | 'needs_approval' required
firstNamestring required

Member first name

lastNamestring required

Member last name

codestring nullable

Member employee code

maxHoursPerWeeknumber nullable

Maximum working hours per week. This value is considered when looking for employees on open shifts, replacements and swaps

maxHoursPerPayPeriodnumber nullable

Maximum working hours per pay period. This value is considered when looking for employees on open shifts, replacements and swaps

hourlyWagenumber nullable

Hourly wage. This value is not available by default. You must make a request to unlock it at api@evolia.com

hourlyWageBySkillCodesobject

Hourly wage by skill (position) codes. If the skill has no code, the value is not present. This value is not available by default. You must make a request to unlock it at api@evolia.com

hourlyWageBySkillIdsobject

Hourly wage by skill (position) ids. This value is not available by default. You must make a request to unlock it at api@evolia.com

pinstring required

Employee pin use to clock in and out of the punch console. Length must be larger than 5 characters

typeobject

FULL_TIME = 1,PART_TIME = 2, SUBSTITUTE = 3, OCCASIONAL = 4, CONTRACTUAL = 5, SUPERNUMERARY = 6, ON_PROBATION = 7, PROSPECT = 8, TRAINING = 9, PARENTAL_LEAVE = 10, STUDENT = 11, REGULAR = 12, SEASONAL = 13, PARTIAL_WITH_RESTRICTION = 14, MANAGER = 15, VOLUNTEER = 16, AGENCY = 17,

typeIdobject required

A member type UID indicating the member status

typeCodeobject required

A member type code indicating the member status

emailstring nullable

Member email

phonestring nullable

Member phone number

hiringDatenumber nullable

Member hiring date in format yyyy-mm-dd

teamIdsstring[] nullable

An array of team UID indicating on which team a member can work

teamCodesstring[] nullable

An array of team code indicating on which team a member can work

skillIdsstring[] nullable

An array of skill UID indicating on which skill (position) a member can work

skillCodesstring[] nullable

An array of skill code indicating on which skill (position) a member can work

locationIdsstring[] nullable

An array of location UID indicating on which location a member can work

locationCodesstring[] nullable

An array of location code indicating on which location a member can work

customobject nullable

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

isAdminboolean

Indicates if the member is an administrator.

gender'M' | 'F' | 'X' | 'P'

Member gender. P mean "Prefer not to say"

emailNotificationboolean

Accept email notifications

pushNotificationboolean

Accept push notifications

birthdatestring

Member date of birth

primaryEmergencyContactNamestring

Member primary emergency contact name

primaryEmergencyContactPhonestring

Member primary emergency contact phone

primaryEmergencyContactNotestring

Member primary emergency contact note

secondaryEmergencyContactNamestring

Member secondary emergency contact name

secondaryEmergencyContactPhonestring

Member secondary emergency contact phone

secondaryEmergencyContactNotestring

Member secondary emergency contact note

Example response

{
  "code": "12",
  "hourlyWageBySkillCodes": {
    "assistant": 18.25,
    "lead": 20.53
  },
  "hourlyWageBySkillIds": {
    "64f1a2b3c4d5e6f7890abcde": 18.25,
    "64f1a2b3c4d5e6f7890abcdf": 20.53
  },
  "pin": "98765",
  "email": "johndoe@email.com",
  "phone": "418-262-1123",
  "custom": {
    "key1": "value1",
    "key2": "value2"
  },
  "gender": "M",
  "birthdate": "2001-01-31",
  "homeAddress": {
    "line2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string"
  }
}

Changes

  • e42abb18d4b6Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status