Patches an employee's phone number.

patch

https://integrationhub.wellsky.io/commands/v4/employees/{id}/phonenumbers/{phoneNumberId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Defaults to null

The unique identifier of the employee.

phoneNumberId

int64

required

Defaults to null

The unique identifier of the phone number to update.

Query Params

api-version

string

The requested API version

Body Params

The request containing the phone number information to patch.

Request to patch (partially update) an employee phone number.

phoneType

string | null

The phone type to possibly update.
Cannot be blank or empty string - use a valid type name or omit this field.
Note: For protected types (Home, Mobile, Work), if this is the FIRST instance of that type
for the employee, the type cannot be changed. Subsequent instances can be edited freely.

number

string | null

The phone number value.
Can be set to empty string ("") to clear the number.

isPrimary

boolean | null

A boolean to set if the phone number is the primary phone number.
This will set any other phone number marked as primary to false.

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200Phone number updated successfully.

400Bad request - validation failed.

404Employee or phone number not found.

500Internal Server Error