API Reference

Creates or replaces the employee's pending name-change request.

put
https://example.com/wep/companies//employees//requests/name

Access: Employee users only.

The saved request echoes back the normalized name payload that will be reviewed by the employer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Company identifier from the route.

int32
required

Employee identifier from the route.

Body Params

Name-change request payload to store.

Payload used to submit or review an employee name-change request.

int32
enum

Members:

  • 1 - Mr ( Mr.. )
  • 2 - Miss ( Miss.. )
  • 3 - Mrs ( Mrs.. )
  • 4 - Ms ( Ms. )
  • 5 - Dr ( Dr.. )
Allowed:
string | null
required

Employee first name.

string | null
required

Employee last name.

string | null

Employee middle name, if any.

string | null

Additional legal or alternate names associated with the employee.

string | null

Preferred nickname for the employee.

string | null

Optional suffix appended to the employee's name.

string | null

Optional employee note submitted together with the name-change request.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Responses

Updated about 1 month ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago