UpdateEmployeePhone - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

000000

Body Params application/json

phone

string

required

Example

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

data

object (EmployeeDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

name

string

required

employeeNumber

string | null

optional

type

optional

string | null

optional

phone

string | null

optional

dob

string <date-time> | null

optional

employment

array[object (IEmployment) {11}] | null

optional

isDeleted

boolean

required

user

object | null

optional

location

string | null

optional

panNumber

string | null

optional

adharNumber

string | null

optional

esiNumber

string | null

optional

epsNumber

string | null

optional

uanNumber

string | null

optional

pfNumber

string | null

optional

country

string | null

optional

bankAccountDetails

optional

currentAddress

optional

permanentAddress

optional

files

array[object (IEmployeeDocument) {3}] | null

optional

voterIdNumber

string | null

optional

drivingLicenseNumber

string | null

optional

picture

string | null

optional

message

string

optional

Example

{
  "data": {
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "__v": 0,
    "_id": "string",
    "organizationId": "string",
    "name": "string",
    "employeeNumber": "string",
    "type": "full-time",
    "email": "string",
    "phone": "string",
    "dob": "2019-08-24T14:15:22Z",
    "employment": [
      {
        "id": "string",
        "isCurrent": true,
        "dateOfJoining": "2019-08-24T14:15:22Z",
        "dateOfLeaving": "2019-08-24T14:15:22Z",
        "specialSchemes": [
          {
            "enabled": true,
            "name": "ESI"
          }
        ],
        "salary": {
          "componentGroup": {
            "id": "string",
            "groupName": "string",
            "salaryCalculationMode": "month-days",
            "sandwichLeaves": true
          },
          "type": "hourly",
          "ctc": 0,
          "gross": 0,
          "net": 0,
          "currency": {
            "name": "string",
            "symbol": "string"
          },
          "components": [
            {
              "name": "string",
              "code": "BASIC",
              "type": "EARNINGS",
              "isTaxable": true,
              "isAttendanceBased": true,
              "isIncludedInCTC": true,
              "isActive": true,
              "_id": "string",
              "value": {
                "amount": 0,
                "currency": {
                  "name": "string",
                  "symbol": "string"
                }
              },
              "formula": "string",
              "custom": true,
              "salaryComponentId": "string",
              "amount": 0
            }
          ]
        },
        "designation": "string",
        "role": "string",
        "supervisor": {
          "id": "string",
          "name": "string",
          "employeeNumber": "string",
          "email": "string",
          "phone": "string",
          "type": "full-time",
          "employment": [
            {}
          ]
        },
        "leavePolicies": [
          {
            "id": "string",
            "name": "string",
            "leaves": [
              {
                "type": "string",
                "probationPeriod": 0,
                "noOfLeaves": 0,
                "monthlyLimit": 0
              }
            ]
          }
        ],
        "spendPolicies": [
          {
            "id": "string",
            "title": "string"
          }
        ]
      }
    ],
    "isDeleted": true,
    "user": {
      "role": "string",
      "id": "string"
    },
    "location": "string",
    "panNumber": "string",
    "adharNumber": "string",
    "esiNumber": "string",
    "epsNumber": "string",
    "uanNumber": "string",
    "pfNumber": "string",
    "country": "string",
    "bankAccountDetails": {
      "bankName": "string",
      "bankAccountNumber": "string",
      "bankBranch": "string",
      "payeeName": "string",
      "IFSC": "string",
      "MICR": "string",
      "SWIFT": "string"
    },
    "currentAddress": {
      "locationName": "string",
      "street1": "string",
      "street2": "string",
      "pincode": "string",
      "city": "string",
      "state": "string",
      "country": "string"
    },
    "permanentAddress": {
      "locationName": "string",
      "street1": "string",
      "street2": "string",
      "pincode": "string",
      "city": "string",
      "state": "string",
      "country": "string"
    },
    "files": [
      {
        "docNumber": "string",
        "docType": "pan",
        "fileUrl": "string"
      }
    ],
    "voterIdNumber": "string",
    "drivingLicenseNumber": "string",
    "picture": "string"
  },
  "message": "string"
}

🟢200Success