POST
/
connections
/
{public_id}
/
sandbox_simulate_carrier_connections
cURL
curl --request POST \
  --url https://sandbox.withclasp.com/connections/{public_id}/sandbox_simulate_carrier_connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "broker_url": "<string>",
  "group_connections": [
    {
      "carrier": "<string>",
      "broker_federal_ein": "<string>",
      "group_id": "<string>",
      "connection": "<string>"
    }
  ],
  "events": [
    {
      "category": "initial_connection",
      "status": "not_started"
    }
  ]
}'
{
  "id": "<string>",
  "broker_url": "<string>",
  "employer": "<string>",
  "group_connections": [
    {
      "id": "<string>",
      "carrier": "<string>",
      "status": "pending",
      "broker_federal_ein": "<string>",
      "group_id": "<string>",
      "connection": "<string>",
      "initiated_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "events": [
    {
      "id": "<string>",
      "category": "initial_connection",
      "status": "not_started",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "status": "<any>"
}

Authorizations

​
Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Path Parameters

​
public_id
string
required

Body

​
group_connections
object[]
required
​
events
object[]
required
​
broker_url
string | null
Maximum length: 255

Response

200 - application/json
​
id
string
required
​
employer
string
required
​
group_connections
object[]
required
​
events
object[]
required
​
status
any
required
​
broker_url
string | null
Maximum length: 255