Patches an employee's email address.

patch

https://integrationhub.wellsky.io/commands/v4/employees/{id}/emailaddresses/{emailAddressId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int64

required

Defaults to null

The unique identifier of the employee.

emailAddressId

int64

required

Defaults to null

The unique identifier of the email address to update.

Query Params

api-version

string

The requested API version

Body Params

The request containing the email address information to patch.

Request to patch (partially update) an employee email address.

emailType

string | null

The type to possibly update for an email address.
Cannot be blank or empty string - use a valid type name or omit this field.

address

string | null

The email address.
Can be set to empty string ("") to clear the address.

isPrimary

boolean | null

A boolean to set if the email address is the primary email address.
This will set any other email address marked as primary to false.
One primary email address must exist at all times.

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

200Email address updated successfully.

400Bad request - validation failed.

404Employee or email address not found.

500Internal Server Error