POST
/
api
/
v1
/
employees
/
{employee_id}
/
member_requests
/
new_hire
Create a New Hire Enrollment Member Request
curl --request POST \
  --url https://fulfillment.noyo.com/api/v1/employees/{employee_id}/member_requests/new_hire \
  --header 'Content-Type: application/json' \
  --data '{
  "coverages": [
    {
      "carrier_config": {},
      "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
      "created": 1557512389,
      "lines_of_coverage": {
        "dental": {
          "enrolling_members": [
            {
              "id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
              "member_type": "employee",
              "plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
            },
            {
              "id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
              "member_type": "dependent",
              "plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
            }
          ]
        },
        "vision": {
          "enrolling_members": [
            {
              "id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
              "member_type": "employee",
              "plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
            },
            {
              "id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
              "member_type": "dependent",
              "plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
            }
          ]
        }
      },
      "modified": 1564440756,
      "signature_date": "2020-01-15"
    }
  ]
}'
{
  "body": {
    "coverages": [
      {
        "carrier_config": {},
        "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
        "lines_of_coverage": {
          "dental": {
            "enrolling_members": [
              {
                "id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
                "member_type": "employee",
                "plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
              },
              {
                "id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
                "member_type": "dependent",
                "plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
              }
            ]
          },
          "vision": {
            "enrolling_members": [
              {
                "id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
                "member_type": "employee",
                "plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
              },
              {
                "id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
                "member_type": "dependent",
                "plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
              }
            ]
          }
        },
        "signature_date": "2020-01-15"
      }
    ]
  },
  "employee_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
  "id": "4f57e463-f4d5-4255-83d4-806b0cabaac5",
  "request_type": "new_hire",
  "result": {},
  "status": "processing",
  "transactions": [
    "a6e30204-87b2-4802-95a4-a156bd0f7435"
  ]
}
The Member Request workflow is now deprecated in favor of using Member Snapshot

Path Parameters

​
employee_id
string<uuid>
required

The unique identifier of the employee related to the member request

Example:

"72af10df-a8b3-46f1-a114-ac36d4b8a6ea"

Body

application/json
​
coverages
object[]
required

List of coverages being added or waived with a set of carriers

Minimum length: 1

Response

201 - application/json

Successful Response - Returns the new Member Request

​
body
object
required

Data required to execute a member request, varies depending on the request type

​
created
integer
required

The date the record was created

​
employee_id
string<uuid>
required

Unique identifier of the employee in Noyo

​
id
string<uuid>
required

Unique identifier of the record in Noyo

​
modified
integer
required

The date the record was last updated

​
request_type
enum<string>
required

Transaction type for the member request

Available options:
demographic,
new_hire,
termination,
open_enrollment,
qualifying_life_event,
enrollment_snapshot,
cobra_enrollment,
cobra_termination,
cobra_open_enrollment,
cobra_qualifying_life_event
​
result
object
required

Result from executing the member request, varies depending on the request type

​
status
enum<string>
required

Status of the member request

Available options:
processing,
completed,
failed,
canceled
​
version
string<uuid>
required

Current version of the record

​
completed
integer

Timestamp indicating when a member request was marked as completed

​
transactions
string<uuid>[]

List of unique identifiers of all associated member transactions in Noyo