Update Employee - Gofive OpenAPI

All fields that have tag 'Required' and 'Nullable' is mean that field required only when adding data, If update data that field is nullable

Request

Header Params

Content-Type

string

required

Accepted value: application/json

Example:

application/json

Ocp-Apim-Subscription-Key

string

required

Api subscription key get from the OpenAPI integration setting page

Example:

WPe123a9RKbcfLQNSztr45

Authorization

string

required

Authorization credential utilized in API requests

Example:

bearer {token}

Body Params application/json

EmployeeRefId

string | null

optional

Unique identifier for referring to employees (Employee No.)

NewEmployeeRefId

string | null

optional

New unique identifier for referring to employees (in case changing employee no)

CompanyName

string

required

Employee company name

TitleId

integer | null

required

Title ID of the employee (can view in Get name prefixes API)

Name

string | null

required

Employee first name

NameEN

string | null

required

Employee first name (in english)

Surname

string | null

required

Employee last name

SurnameEN

string | null

required

Employee last name (in english)

NickName

string | null

optional

Employee nickname

NickNameEN

string | null

optional

Employee nickname (in english)

Gender

integer | null

required

Gender ID (1 = Male, 2 = Female, 3 = Other)

DateHired

string | null

required

Employee employment date (format : YYYY-MM-DD)

DateOfBirth

string | null

required

Employee date of birth (format : YYYY-MM-DD)

upperSupervisorNo

string | null

optional

Supervisor employee No. of the employee

pictureType

string | null

optional

Employee profile picture type

originalPicture

string | null

optional

Employee picture (Base64)

Example

{
    "EmployeeRefId": "23030",
    "CompanyName": "empeo Dev Test",
    "Name": "เทสชื่อ",
    "NameEN": "Test name bff",
    "Surname": "เทสนามสกุล",
    "SurnameEN": "Test surname bff",
    "NickName": "บีเอฟบอย",
    "NickNameEN": "bff boy",
    "Gender": 1,
    "dateOfBirth":"2023-01-20",
    "DateHired": "2023-07-04",
    "upperSupervisorNo": "99999",
    "PictureType": "image/png",
    "OriginalPicture": "iVBORw0KGgoAAAANSUhEUgAAB4AAAAQ4CAIAAABnsVYUAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAP+lSURBVHhe7P0HV1tnGuhvb3rH9F5Ek4SQQL0ikASi915sjGvsOMXpM+m248RJnMRx773Tm3rvCNuZ843ep0hCCHBJMjlz3vX3+q29NkIIkAWz5vKdexNW9b0ts2nvr6d5uGVW9QOcRfUQ9ciy8ti68tS28tSy/OSVgbv9ueyqqUAO9axDPYdzauZfGbon+JDp4IIfMDib6gn4juD35fsGQeCbvQ8yq+6bQOpA90zqu0HdMalvo26Z1DdARtV11M2gbhlXbptVdy2we/hhUb7n06p+Ar4A+8Ycmsebc2qfbGwqkN3XtEM3ExR4c8rfU4f+8evkMjz9c4U8jl33KKSQ1xXOrnnoAEfVoy2zrYAeb86+VYH3WpY3fdTSI38PbcsPrEv3rYuge5aF2yDz/K3gTPO3jAuhmRZvB2deuoWzrNyGwb/cO1YNzKK9a9Xdw9kN918/m+G+RX/nNbPq1j/LSwJfjEULjvdRD82aBxb4s/zI35OXtPll+fIc6qevm+Zp8KsXv4CDX7pu/SzIo59dNcxtbOENW3r9PPpFt27rQu75yrzG5T9RyIOA/F/Sgls/v6k5/CyBXLqZQE7tdMhzC7Krn9o0MPyLAvxmcBlgbuOUxzS9ap7yWKY81mmP9SnOa5/6iwUeym158vq5zI9xTtOj4BzGhw7jg1cW8gMV0qafCxT8mb1tVd2wrly3LV+3Ll2zLF61Ll61zF+xzl0GWWavWGeu2Hxdtc1ce2X22euBHHM3HHO3QDaUff42yLlwx7lwz7lwH/XAufBwc67FR8G5lx4Hci09di77cq08AXmWp0CulZflXH76p7Nvk23pSUjWxccvybLwaMvM8w/N8w9Aprn7IOPsPcMMavbOS7ttmL6pn7ph8HXd+OS66el1w6MrSzd+efTb1ze+++DCFwd+/XD8hyMDx/a3f75T8cmQ5MM+wfvd3Pc6mO+2099pq3qnrfLtFspbTRUHleWHminglqNdzPc6mW+3MfYrqXvk5H0N1INN9MOtzEOtzLdamQdbarbrrTbWoXb2kU7u4Q7OoXZwzjzUXnOghb6zvryfn9fFyurj5Y5LS/Y0UvaCR24kT8jLdstKd0pJY+KCYWHuqChvV13RpKxkb0PZvsbyvYqKifrSXXUl4Dgiyu9hpg7wsvYoSvcry0dEOe30hM7qxGFh1k5p/m5Z0a66wkFeVh87fUiQM1FXvFdRNikvHpPkgjuM1+ZN1BeC45AgEzQszAH3GeCB82z86XZKC8GnHhODxyHtV1aA9shLJ+pJu+rAI+SDuw1wM/s5GSDwUaB+bnofB3wx4HNlDvIzBoWZo7V5expLD7RUTCiKh0TZfbz0AWHmgCC9k5XYSo/tZqeAN4fFuaO1BePgMzaU7VVSJhvKdytKd9YXD4pyerlpnazkHvCYwswhUdaAEDxCJmikNne3grS/uWK8rhC82V6d1ESL7edn7FGW7msuB4+zU1Y8IskfFud1MlMUFVGt9MRudlonO62bm9HDy+hkp3awUjpYqQpKDCeXkJDCFdSYdmbKmKxkXFY6Vl8yUlfcL8zrZKUPiQoOd1S/08UCfymjtUWDwvxhSfGotGRIUtzDywMNiot3ysiTzYz9Haz9HezJ1pqJ5ppRBa1XXNrCypVVponLkvjFcZVpYYXRRHEsIaOldQtJbey8Dk5+N6+oh1/Uxc3vZOd0sLLbmRnN9BQlLbmxMrGZntzBSm9npjUxkhqq4ltqkptrkmWU2Kp0IjecoCQTjVVJ3fzsHkFOFy8TvFdJiwM10+PbmIndvNROTnJTVXQjLbKdFdfLT+nlJXex4tuZMW3VUa2MiLbqyPaa6A5mDKgT3F4T20KPbKgMb6SFNzOiu7iJfcKUAXEaOILzNmZ068aaGREKKlFfQdSVwyNITiWUVWHgdlATPRycg8Dt/EKCm0dISgg5hVBUEjLwUag6CiElE5IyQlIKqy0lpGWErIyQl/tSkIkGKniQqKbq2GZmnJIRq6BFyiojZNRwWGUEeLORHtNUE9tQHdVYHQ0CJyAFIxKfhKRgRMvpUfKqqPrKiDpqRC0lorYysq4qWkqLqq2MEpIjBRUR/PIIThkoilcRw6fE8qgJ/MpEfmWSkJYiqkoV09Mk1ekwRiZITM8QVaULaOncyjQONZVNSWFV7KguTQTVlCUzy1O51CxRTWEdt1whpDVLmV2Nwp4mcauM16kUTQy17RpsHepqGOyUD3TIuprETXXsOj5NyCznV5P4zBIOo5jJKGAy8qurcunUbDols7I8vbQwOS8zOictMjc1Ki2eiA8nogkinCDCiC3+gNtjCGJHOJGbQJSkELScsJrCSE5JNL88TlAWyyqMrMwgylOI8lSCnB5GzYqgZePCyRlEWSpBSiFKUonSdKIM3C2ToOYS9AKCUQiPtHyiqoCoLiKYpDBcTXEYeJNeCO8Aby+OYJFgbBL4jBG8MvD0xkoqE+roybLqFEVNagMztZGZpmSl45rYma2crBZ2JiojUDN4F7hbTUpTTUozK62Nm9klyOkV5/fXFvZLiwakJNAQarCWBH4eQcO1pBEp+BEuBz/FI5LCXm52e3VKK/hRqknt5+eM15HAT/G+pkoQ+D0DzkHg9+1bbfR3e9hH+3mgDwb4n4xI/r2z7osJ2VeTim/2NHwz2fj1RAPom92N30wovp2Qfbu79vi+uhNvyU6+o/j+PcVPnyiv/zi8fP99h+pbr/n7NduPa44fvS7YmvvnNfdp1C/+fl1z/xbSM8/Z56vnUBeeeS+CnnuvvFi7+mLt2ou1Gy/WbqJuv37PvbeebWpt9eaax5fXfQO36rqGuuJxXvY4L4LcjgtuxzmQy34W5Ladc9vOu6znQE6LL4flnN1ywW65iLpkt1x2WK84rNdAdus1m/UG6pa/Ozir5bYltJubM5mvGS2+DOZrevPV4Pzvum6w3DCYbxrMt43mO0bzPaP5ocHyxGidNVoXTLYVs11jtumtdlMgm8MKsjvtdqfD7rI73I4tc3qcIHtQ+BaU+03+rIJcLk8gp8vj8Gd3eaxOt8XhMtudRptdbwVfq01nsegsZp3ZpDUZQRqjQWPUag0ovVqjX1HrllTaRbV2Tq2ZBUeVZhamnl5RTy2rHoOWVh4urNydX7mFujGzfG1m+SrqCm525TJMdWVuQ5dRl1AXF9S4Cwvq86BFzfklzbkV7TmV9ixM//uK/neV4QzMGOis2nhObTqnMZ/XWi7pLJf11isgg+2qwXbdYLtptN8y2u4YbfeMtgcm+2OTfcpkmzHb5832RatjxerQ2Jx6kN1lsrssdpfV4fb9BYHnPJBr1eNadXk8Ls+qa9XrXkV/1mDeZ9410IvVtT/Wnv/hfbF9z/+P99nr95+1Z39s6oW/5+iTbhf4qtDXtjnwrmdez5rX7V3z5wXfEMjpWfXncbrBK8btdDmdTofTaXOA164NZAHZrCab1Wi1GCxmvcWkMxu0Jp3GqNEY1WrDstqwpDYsopZU+g2t6BaXdQvLuvll3dxLmwGt6OZV+gUQfEDwyGaNxqzXmI3wJWq1gJerwW43OpxmO3gZe6wOj925CnK4vCCn0+vaJrd77a/nAq8D+DPldqE/4PmBP9ROO/4ZB1kdVrPDYnaYTHajya432rQGm1pnXdba5jXWaY11SmN9qrY8VlseqK331NZbKss1leWKynpJZb2wYjm7Yvl1xfKzyvKj2vKD2nJSbT6+sW9Vpq81pq9Q4OSY1vSd1vS91nRKYz6tMZ/RWS7owOvfdkNvv2Vw3DY67pmc903Ox1bntM0173Atudxqt1vv8RhXPWavx7LmsT7z2FD256tOlHvLXni9L8DrfLtWQc9erD739+K5J7QXq3+8ZsEf9cz9LLg197NV1xrI4wr6S3Gv4b99HHgx2NALA7w8wIvEZHcbwE+41aWzONVmx4rJvmy0gbYFaKtmW3cO9FcAGt/tTxRixEiTcXNOzavz3/mNABqEv0HQ3wjQt98coB+F0DNuoz5vAGjHFvoMCgJo/WsBtFP/JISVX7+QhwK9DkA7/l8A6BB9Br0mQNv0b2DQ/wxAg14ToEFvZNChyrx9Ts36S9f/6v1fAOilYHQOLuSeryxEll+zkAcB/SmA3vDc4sBzHtBn9IsiANDTCKBnPJbp/w+ggwHaOn/Fhg36/18AOlAILr9OIe4cKESfA4W4c6AQdw5uI0DffzVAz9wxTN/y0/MN4/RN8/RNrM+q2+emL3x/+9Snl746/OvHu0+9M3jiYNfXk02fjdZ92C882sN9r4v1bnvNO20QoI+0Ut9uoRxqrnirqeLtlsp3OxhHu5nvdtS81Uzb20DZIyfvb6w81MLAAB0izhtqZWKARvrMxgB9sJUxqaAMiQp72Nm9nJxhUdGEvGKvkjrZQJ6Qle2sK0H6XDgszB8V5++sLdwtI+2Rl+5RQIDeLfPp87ikqJ+T1cfJmKgvPthMmagr7GWn

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.gofive.co.th/empeo/api/v2/profiles' \
--header 'Ocp-Apim-Subscription-Key: WPe123a9RKbcfLQNSztr45' \
--header 'Authorization: bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "EmployeeRefId": "23030",
    "CompanyName": "empeo Dev Test",
    "Name": "เทสชื่อ",
    "NameEN": "Test name bff",
    "Surname": "เทสนามสกุล",
    "SurnameEN": "Test surname bff",
    "NickName": "บีเอฟบอย",
    "NickNameEN": "bff boy",
    "Gender": 1,
    "dateOfBirth":"2023-01-20",
    "DateHired": "2023-07-04",
    "upperSupervisorNo": "99999",
    "PictureType": "image/png",
    "OriginalPicture": "iVBORw0KGgoAAAANSUhEUgAAB4AAAAQ4CAIAAABnsVYUAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAP+lSURBVHhe7P0HV1tnGuhvb3rH9F5Ek4SQQL0ikASi915sjGvsOMXpM+m248RJnMRx773Tm3rvCNuZ843ep0hCCHBJMjlz3vX3+q29NkIIkAWz5vKdexNW9b0ts2nvr6d5uGVW9QOcRfUQ9ciy8ti68tS28tSy/OSVgbv9ueyqqUAO9axDPYdzauZfGbon+JDp4IIfMDib6gn4juD35fsGQeCbvQ8yq+6bQOpA90zqu0HdMalvo26Z1DdARtV11M2gbhlXbptVdy2we/hhUb7n06p+Ar4A+8Ycmsebc2qfbGwqkN3XtEM3ExR4c8rfU4f+8evkMjz9c4U8jl33KKSQ1xXOrnnoAEfVoy2zrYAeb86+VYH3WpY3fdTSI38PbcsPrEv3rYuge5aF2yDz/K3gTPO3jAuhmRZvB2deuoWzrNyGwb/cO1YNzKK9a9Xdw9kN918/m+G+RX/nNbPq1j/LSwJfjEULjvdRD82aBxb4s/zI35OXtPll+fIc6qevm+Zp8KsXv4CDX7pu/SzIo59dNcxtbOENW3r9PPpFt27rQu75yrzG5T9RyIOA/F/Sgls/v6k5/CyBXLqZQE7tdMhzC7Krn9o0MPyLAvxmcBlgbuOUxzS9ap7yWKY81mmP9SnOa5/6iwUeym158vq5zI9xTtOj4BzGhw7jg1cW8gMV0qafCxT8mb1tVd2wrly3LV+3Ll2zLF61Ll61zF+xzl0GWWavWGeu2Hxdtc1ce2X22euBHHM3HHO3QDaUff42yLlwx7lwz7lwH/XAufBwc67FR8G5lx4Hci09di77cq08AXmWp0CulZflXH76p7Nvk23pSUjWxccvybLwaMvM8w/N8w9Aprn7IOPsPcMMavbOS7ttmL6pn7ph8HXd+OS66el1w6MrSzd+efTb1ze+++DCFwd+/XD8hyMDx/a3f75T8cmQ5MM+wfvd3Pc6mO+2099pq3qnrfLtFspbTRUHleWHminglqNdzPc6mW+3MfYrqXvk5H0N1INN9MOtzEOtzLdamQdbarbrrTbWoXb2kU7u4Q7OoXZwzjzUXnOghb6zvryfn9fFyurj5Y5LS/Y0UvaCR24kT8jLdstKd0pJY+KCYWHuqChvV13RpKxkb0PZvsbyvYqKifrSXXUl4Dgiyu9hpg7wsvYoSvcry0dEOe30hM7qxGFh1k5p/m5Z0a66wkFeVh87fUiQM1FXvFdRNikvHpPkgjuM1+ZN1BeC45AgEzQszAH3GeCB82z86XZKC8GnHhODxyHtV1aA9shLJ+pJu+rAI+SDuw1wM/s5GSDwUaB+bnofB3wx4HNlDvIzBoWZo7V5expLD7RUTCiKh0TZfbz0AWHmgCC9k5XYSo/tZqeAN4fFuaO1BePgMzaU7VVSJhvKdytKd9YXD4pyerlpnazkHvCYwswhUdaAEDxCJmikNne3grS/uWK8rhC82V6d1ESL7edn7FGW7msuB4+zU1Y8IskfFud1MlMUFVGt9MRudlonO62bm9HDy+hkp3awUjpYqQpKDCeXkJDCFdSYdmbKmKxkXFY6Vl8yUlfcL8zrZKUPiQoOd1S/08UCfymjtUWDwvxhSfGotGRIUtzDywMNiot3ysiTzYz9Haz9HezJ1pqJ5ppRBa1XXNrCypVVponLkvjFcZVpYYXRRHEsIaOldQtJbey8Dk5+N6+oh1/Uxc3vZOd0sLLbmRnN9BQlLbmxMrGZntzBSm9npjUxkhqq4ltqkptrkmWU2Kp0IjecoCQTjVVJ3fzsHkFOFy8TvFdJiwM10+PbmIndvNROTnJTVXQjLbKdFdfLT+nlJXex4tuZMW3VUa2MiLbqyPaa6A5mDKgT3F4T20KPbKgMb6SFNzOiu7iJfcKUAXEaOILzNmZ068aaGREKKlFfQdSVwyNITiWUVWHgdlATPRycg8Dt/EKCm0dISgg5hVBUEjLwUag6CiElE5IyQlIKqy0lpGWErIyQl/tSkIkGKniQqKbq2GZmnJIRq6BFyiojZNRwWGUEeLORHtNUE9tQHdVYHQ0CJyAFIxKfhKRgRMvpUfKqqPrKiDpqRC0lorYysq4qWkqLqq2MEpIjBRUR/PIIThkoilcRw6fE8qgJ/MpEfmWSkJYiqkoV09Mk1ekwRiZITM8QVaULaOncyjQONZVNSWFV7KguTQTVlCUzy1O51CxRTWEdt1whpDVLmV2Nwp4mcauM16kUTQy17RpsHepqGOyUD3TIuprETXXsOj5NyCznV5P4zBIOo5jJKGAy8qurcunUbDols7I8vbQwOS8zOictMjc1Ki2eiA8nogkinCDCiC3+gNtjCGJHOJGbQJSkELScsJrCSE5JNL88TlAWyyqMrMwgylOI8lSCnB5GzYqgZePCyRlEWSpBSiFKUonSdKIM3C2ToOYS9AKCUQiPtHyiqoCoLiKYpDBcTXEYeJNeCO8Aby+OYJFgbBL4jBG8MvD0xkoqE+roybLqFEVNagMztZGZpmSl45rYma2crBZ2JiojUDN4F7hbTUpTTUozK62Nm9klyOkV5/fXFvZLiwakJNAQarCWBH4eQcO1pBEp+BEuBz/FI5LCXm52e3VKK/hRqknt5+eM15HAT/G+pkoQ+D0DzkHg9+1bbfR3e9hH+3mgDwb4n4xI/r2z7osJ2VeTim/2NHwz2fj1RAPom92N30wovp2Qfbu79vi+uhNvyU6+o/j+PcVPnyiv/zi8fP99h+pbr/n7NduPa44fvS7YmvvnNfdp1C/+fl1z/xbSM8/Z56vnUBeeeS+CnnuvvFi7+mLt2ou1Gy/WbqJuv37PvbeebWpt9eaax5fXfQO36rqGuuJxXvY4L4LcjgtuxzmQy34W5Ladc9vOu6znQE6LL4flnN1ywW65iLpkt1x2WK84rNdAdus1m/UG6pa/Ozir5bYltJubM5mvGS2+DOZrevPV4Pzvum6w3DCYbxrMt43mO0bzPaP5ocHyxGidNVoXTLYVs11jtumtdlMgm8MKsjvtdqfD7rI73I4tc3qcIHtQ+BaU+03+rIJcLk8gp8vj8Gd3eaxOt8XhMtudRptdbwVfq01nsegsZp3ZpDUZQRqjQWPUag0ovVqjX1HrllTaRbV2Tq2ZBUeVZhamnl5RTy2rHoOWVh4urNydX7mFujGzfG1m+SrqCm525TJMdWVuQ5dRl1AXF9S4Cwvq86BFzfklzbkV7TmV9ixM//uK/neV4QzMGOis2nhObTqnMZ/XWi7pLJf11isgg+2qwXbdYLtptN8y2u4YbfeMtgcm+2OTfcpkmzHb5832RatjxerQ2Jx6kN1lsrssdpfV4fb9BYHnPJBr1eNadXk8Ls+qa9XrXkV/1mDeZ9410IvVtT/Wnv/hfbF9z/+P99nr95+1Z39s6oW/5+iTbhf4qtDXtjnwrmdez5rX7V3z5wXfEMjpWfXncbrBK8btdDmdTofTaXOA164NZAHZrCab1Wi1GCxmvcWkMxu0Jp3GqNEY1WrDstqwpDYsopZU+g2t6BaXdQvLuvll3dxLmwGt6OZV+gUQfEDwyGaNxqzXmI3wJWq1gJerwW43OpxmO3gZe6wOj925CnK4vCCn0+vaJrd77a/nAq8D+DPldqE/4PmBP9ROO/4ZB1kdVrPDYnaYTHajya432rQGm1pnXdba5jXWaY11SmN9qrY8VlseqK331NZbKss1leWKynpJZb2wYjm7Yvl1xfKzyvKj2vKD2nJSbT6+sW9Vpq81pq9Q4OSY1vSd1vS91nRKYz6tMZ/RWS7owOvfdkNvv2Vw3DY67pmc903Ox1bntM0173Atudxqt1vv8RhXPWavx7LmsT7z2FD256tOlHvLXni9L8DrfLtWQc9erD739+K5J7QXq3+8ZsEf9cz9LLg197NV1xrI4wr6S3Gv4b99HHgx2NALA7w8wIvEZHcbwE+41aWzONVmx4rJvmy0gbYFaKtmW3cO9FcAGt/tTxRixEiTcXNOzavz3/mNABqEv0HQ3wjQt98coB+F0DNuoz5vAGjHFvoMCgJo/WsBtFP/JISVX7+QhwK9DkA7/l8A6BB9Br0mQNv0b2DQ/wxAg14ToEFvZNChyrx9Ts36S9f/6v1fAOilYHQOLuSeryxEll+zkAcB/SmA3vDc4sBzHtBn9IsiANDTCKBnPJbp/w+ggwHaOn/Fhg36/18AOlAILr9OIe4cKESfA4W4c6AQdw5uI0DffzVAz9wxTN/y0/MN4/RN8/RN

Responses

🟢200Success

application/json

Body

object {0}

Example

{
    "status": {
        "code": "1000",
        "description": "Success"
    },
    "data": {
        "httpCode": 200,
        "result": true,
        "description": "Success",
        "metadata": {
            "result": true,
            "message": "Update successfully"
        },
        "responseStatus": {
            "code": "1000",
            "description": "Success"
        },
        "statusCode": "1000"
    }
}