latestOpenAPI 3.0.12026-07-26222700728.0 KB

e9f0790a89af

Employee Management

Save employees

Save new (or update existing) employees

post/v6/employees

Request body

Example request

{
  "data": [
    {
      "id": "emp_12345",
      "userId": "usr_67890",
      "email": "employee@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "billableRate": 150,
      "ownershipPercentage": 25.5,
      "status": "ACTIVE",
      "customData": {
        "internal_key": "some_internal_key",
        "some_other_field": 23434
      }
    }
  ]
}

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": [
    {
      "data": {
        "id": "emp_12345",
        "userId": "usr_67890",
        "email": "employee@example.com",
        "firstName": "John",
        "lastName": "Doe",
        "billableRate": 150,
        "ownershipPercentage": 25.5,
        "dimensionValues": [
          {
            "id": "dv_593051",
            "dimension": {
              "id": "dim_4521",
              "name": "Region",
              "requiredness": "NOT_REQUIRED"
            },
            "name": "Mid-Atlantic",
            "child": {
              "id": "dv_593052",
              "dimension": {
                "id": "dim_4521",
                "name": "Region",
                "requiredness": "NOT_REQUIRED"
              },
              "name": "Washington DC"
            }
          }
        ],
        "status": "ACTIVE",
        "customData": {
          "internal_key": "some_internal_key",
          "some_other_field": 23434
        }
      }
    }
  ]
}