Update an employee

Request

Security

form_session or user_session or component_session or component_token or api_token

Path

employee_idstring(EmployeeId)^ee_required

Employee Identifier

Bodyapplication/jsonrequired

first_namestring

middle_namestring

last_namestring

emailstring or null

Any of:

string

phonestring or null

Any of:

string

date_of_birthstring or null

Any of:

string

social_security_numberstring or null

Any of:

string

has_middle_nameboolean or null

Any of:

boolean

addressAddress (object) or null

Any of:

An address resource

custom_attributesobject(CustomAttributes)

Record of custom attribute values keyed by string path.

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employees/{employee_id}' \
  -H 'Authorization: Bearer <YOUR_Onboarded form session token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "date_of_birth": "string",
    "social_security_number": "string",
    "has_middle_name": true,
    "address": {
      "street": "123 Main St",
      "secondary": "Suite 100",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94102",
      "country": "US",
      "full_address": "123 Main St, San Francisco, CA 94102"
    },
    "custom_attributes": {
      "property1": null,
      "property2": null
    },
    "property1": null,
    "property2": null
  }'

Responses

An employee with standard fields plus any system-defined custom attributes as top-level properties. System attributes are organization-specific fields (ScalarValue: string, number, boolean, or null) that extend the base employee schema.

Bodyapplication/json

idstring(EmployeeId)^ee_required

Employee Identifier

first_namestringrequired

middle_namestring

last_namestringrequired

emailstring or nullrequired

Any of:

string

phonestring or nullrequired

Any of:

string

date_of_birthstring or nullrequired

Any of:

string

social_security_numberstring or nullrequired

Any of:

string

has_middle_nameboolean or nullrequired

Any of:

boolean

addressAddress (object) or nullrequired

Any of:

An address resource

custom_attributesobject(CustomAttributes)required

Record of custom attribute values keyed by string path.

created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

property name*any(ScalarValueUnknown)additional property

Unknown value that should be a JSON scalar (string, number, boolean, or null) but is not runtime-validated. Use ScalarValue for validation at serialization boundaries.

Response

{
  "id": "ee_abc123def456",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "email": "string",
  "phone": "string",
  "date_of_birth": "string",
  "social_security_number": "string",
  "has_middle_name": true,
  "address": {
    "street": "123 Main St",
    "secondary": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "zip": "94102",
    "country": "US",
    "full_address": "123 Main St, San Francisco, CA 94102"
  },
  "custom_attributes": {
    "property1": null,
    "property2": null
  },
  "created_at": "string",
  "updated_at": "string",
  "property1": null,
  "property2": null
}