Sign in

v1

latestOpenAPI 3.1.02026-07-22191956.7 KB
Census

Add a member

Adds one member to the census: the new-hire path. After enrollment, additions propagate to the live company census automatically.

post/groups/{groupId}/members

Path parameters

groupIdstring required

Group ID, e.g. grp_8c2f41d09a3e.

Headers

Idempotency-Keystring

Any unique string (UUIDs work well). Replaying the same key within 24 hours returns the stored response instead of re-executing the request.

Request body

OR

Example request

{
  "externalId": "emp_0001",
  "firstName": "Jordan",
  "lastName": "Reyes",
  "email": "jordan@acme.com",
  "dob": "1992-03-14",
  "age": 34,
  "zip": "94110",
  "hireDate": "2024-03-01",
  "dependents": [
    {
      "dob": "2019-10-02",
      "name": "Mia Fischer"
    }
  ]
}

Response

Member stored.

OR

Example response

{
  "memberId": "mem_c4a91f27e83d"
}