Skip to main content
PUT
/
employees
/
{id}
Update an employee
curl --request PUT \
  --url https://psn-api.paystub.dev/employees/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_id": 123,
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "ssn": "<string>",
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "country": "<string>",
  "additional_info": {},
  "earnings": {},
  "deductions": {}
}
'
{
  "success": true,
  "data": {
    "id": 123,
    "site_id": 123,
    "user_id": 123,
    "company_id": 123,
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "email": "[email protected]",
    "phone": "+1234567890",
    "ssn": "123-45-6789",
    "masked_ssn": "XXX-XX-6789",
    "additional_info": {},
    "earnings": {},
    "deductions": {},
    "address": {
      "address1": "123 Main St",
      "address2": "Apt 4B",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "country": "US",
      "full_address": "123 Main St, Apt 4B, New York, NY 10001, US",
      "formatted_address": "123 Main St<br>Apt 4B<br>New York, NY 10001<br>US"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "company": {
      "id": 123,
      "site_id": 123,
      "user_id": 123,
      "name": "Acme Inc",
      "email": "[email protected]",
      "phone": "+1234567890",
      "ein": "12-3456789",
      "masked_ein": "XX-XXX6789",
      "address": {
        "address1": "123 Main St",
        "address2": "Suite 100",
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "US",
        "full_address": "123 Main St, Suite 100, New York, NY 10001, US",
        "formatted_address": "123 Main St<br>Suite 100<br>New York, NY 10001<br>US"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "employees": [
        {}
      ],
      "documents": [
        {
          "id": 123,
          "site_id": 123,
          "user_id": 123,
          "order_id": 123,
          "company_id": 123,
          "employee_id": 123,
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "Paystub",
          "template_id": "<string>",
          "color_id": "<string>",
          "quantity": 2,
          "content": {},
          "storage_data": {},
          "errors": {},
          "status": "Pending",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "company": {},
          "employee": {}
        }
      ],
      "employees_count": 123,
      "documents_count": 123
    },
    "documents": [
      {
        "id": 123,
        "site_id": 123,
        "user_id": 123,
        "order_id": 123,
        "company_id": 123,
        "employee_id": 123,
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "type": "Paystub",
        "template_id": "<string>",
        "color_id": "<string>",
        "quantity": 2,
        "content": {},
        "storage_data": {},
        "errors": {},
        "status": "Pending",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "company": {},
        "employee": {}
      }
    ],
    "documents_count": 123
  },
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

Use your API token

Path Parameters

id
integer
required

Employee ID

Body

application/json
company_id
integer
first_name
string
last_name
string
email
string<email>
phone
string
ssn
string
address1
string
address2
string
city
string
state
string
zip
string
country
string
Required string length: 2
additional_info
object
earnings
object
deductions
object

Response

200 - application/json

Employee updated successfully

success
boolean
Example:

true

data
object
message
string | null