Skip to main content
POST
/
open_enrollment_windows
cURL
curl --request POST \
  --url https://sandbox.withclasp.com/open_enrollment_windows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employer": "<string>",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "plans": [
    "<string>"
  ],
  "metadata": {}
}
'
import requests

url = "https://sandbox.withclasp.com/open_enrollment_windows"

payload = {
    "employer": "<string>",
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "plans": ["<string>"],
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    employer: '<string>',
    start_date: '2023-12-25',
    end_date: '2023-12-25',
    plans: ['<string>'],
    metadata: {}
  })
};

fetch('https://sandbox.withclasp.com/open_enrollment_windows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.withclasp.com/open_enrollment_windows",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'employer' => '<string>',
    'start_date' => '2023-12-25',
    'end_date' => '2023-12-25',
    'plans' => [
        '<string>'
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.withclasp.com/open_enrollment_windows"

	payload := strings.NewReader("{\n  \"employer\": \"<string>\",\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\",\n  \"plans\": [\n    \"<string>\"\n  ],\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sandbox.withclasp.com/open_enrollment_windows")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"employer\": \"<string>\",\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\",\n  \"plans\": [\n    \"<string>\"\n  ],\n  \"metadata\": {}\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.withclasp.com/open_enrollment_windows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"employer\": \"<string>\",\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\",\n  \"plans\": [\n    \"<string>\"\n  ],\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "employer": "<string>",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "renewal_date": "2023-12-25",
  "completed_at": "2023-11-07T05:31:56Z",
  "completed_member_count": 123,
  "incomplete_member_count": 123,
  "summaries": [
    {}
  ],
  "plans": [
    "<string>"
  ],
  "metadata": {}
}

Authorizations

Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Body

application/json
employer
string
required
start_date
string<date>
required
end_date
string<date>
required
plans
string[]
enrollment_type
enum<string>
  • active - Active
  • passive - Passive
Available options:
active,
passive
metadata
object

Up to 50 key-value pairs. Keys max 40 characters, values max 500 characters. Set a value to empty string to remove a key. On PATCH, metadata is merged with existing values.

Response

201 - application/json
id
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
employer
string
required
start_date
string<date>
required
end_date
string<date>
required
renewal_date
string<date>
required
read-only
status
enum<string>
required
  • setup_required - Setup Required
  • build_in_progress - Build In Progress
  • active - Active
  • closed - Closed
  • completed - Completed
Available options:
setup_required,
build_in_progress,
active,
closed,
completed
completed_at
string<date-time> | null
required
read-only
completed_member_count
integer
read-only
incomplete_member_count
integer
read-only
summaries
object[] | null
read-only
plans
string[]
enrollment_type
enum<string>
  • active - Active
  • passive - Passive
Available options:
active,
passive
metadata
object

Up to 50 key-value pairs. Keys max 40 characters, values max 500 characters. Set a value to empty string to remove a key. On PATCH, metadata is merged with existing values.