/companies/{company_id}/participants/{participant_id}/

put

https://dev.401go.com/api/companies/{company_id}/participants/{participant_id}/

Update an existing participant by id for the given company_id. You cannot add deductions or update met_eligibility_date. If you try to change an email, it will create an additional login for the user with the new email so it doesn't lock out their previous login

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

company_id

string

required

participant_id

string

required

Body Params

Represents a participant in a companies 401k account. 'met_eligibility_date' will be returned as non-null and in the past once a participant is eligible to contribute. In addition, for ineligible participants, the deferrals will always have a 0 amount. When creating a participant, either phone or email are required (preferably both). When updating a participant, object_id is required. If a 'termination_date' has previously been set, pushing a 'start_date' after it will rehire this participant.

object_id

string | null

name

string

required

length between 1 and 100

string

length ≥ 1

phone

string

length ≥ 1

start_date

date

required

The latest date this participant was hired or rehired. Pushing a start_date that is after a previously set termination_date will rehire this participant.

termination_date

date | null

ssn

string

required

length ≤ 9

dob

date | null

hours_worked_ytd

string

compensation_ytd

string

years_worked_1000_hours

integer | null

0 to 65535

prior_year_total_compensation

string

ownership_percentage

string

company_officer

boolean

address

object | null

A participant's Address

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request: Invalid participant data

401

Unauthorized: Missing or invalid authentication

403

Forbidden: Insufficient permissions or scopes

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200