Skip to main content
POST
/
api
/
v1
/
groups
/
{group_id}
/
renewal_decisions
Create a new renewal decision
curl --request POST \
  --url https://fulfillment.noyo.com/api/v1/groups/{group_id}/renewal_decisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": {
    "carriers": [
      {
        "carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "lines_of_coverage": {
          "accident": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "add": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "cancer": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "critical_illness": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "dental": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "health_fund": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "hospital_indemnity": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "life": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "ltd": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "medical": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "pharmacy": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "std": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "vision": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "wellness": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          }
        }
      }
    ]
  },
  "renewal_date": "2023-12-25"
}
'
{
  "body": {
    "carriers": [
      {
        "carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "lines_of_coverage": {
          "accident": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "add": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "cancer": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "critical_illness": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "dental": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "health_fund": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "hospital_indemnity": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "life": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "ltd": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "medical": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "pharmacy": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "std": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "vision": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          },
          "wellness": {
            "open_enrollment_end_date": "2022-02-01",
            "open_enrollment_start_date": "2022-01-01",
            "plans": [
              {
                "name": "<string>",
                "plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          }
        }
      }
    ]
  },
  "created": 123,
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "issues": [
    {
      "level": "warning",
      "message": "<string>",
      "carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "line_of_coverage": "<string>"
    }
  ],
  "modified": 123,
  "renewal_date": "2023-12-25",
  "status": "submitted",
  "version": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
group_id
string<uuid>
required

The unique identifier of the group for which you are creating a new renewal decision

Example:

"2613a221-d3c8-4c8a-86d5-e7e885fd1da9"

Body

application/json
​
body
object
required

The carrier and coverage expectations for the open enrollment period

​
renewal_date
string<date>
required

The start date for the new enrollment year when all coverages should be active

Response

201 - application/json

Successful Response - Returns the new Renewal Decision

​
body
object
required

The carrier and coverage expectations for the open enrollment period

​
created
integer
required

The date the record was created

​
group_id
string<uuid>
required

Unique identifier of the group in Noyo

​
id
string<uuid>
required

Unique identifier of the record in Noyo

​
issues
object[]
required

List of any issues that explain why the open enrollment is 'not_ready'. Will be empty if it is status 'ready' or 'submitted'.

​
modified
integer
required

The date the record was last updated

​
renewal_date
string<date>
required

The start date for the new enrollment year when all coverage changes and decisions should become active

​
status
enum<string>
required

Calculated status based on whether or not the carrier system matches the expected renewal decisions

Available options:
submitted,
not_ready,
ready,
done
​
version
string<uuid>
required

Current version of the record