Skip to main content
POST
Create a new Group Connection

Authorizations

Authorization
string
header
required

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

Body

application/json
carrier_id
string<uuid>
required

Unique identifier of the carrier in Noyo

group_data
object
required

Carrier-specific data to execute a group connection

data_exchange_configuration
enum<string>

Use the specified data exchange configuration without calculating connection eligibility

Available options:
api,
edi
federal_ein
string

Federal Employer Identification Number for the new group/company

Example:

"123123123"

ignore_eligibility
boolean

Use the best available data exchange configuration without calculating connection eligibility

Response

201 - application/json

Successful Response - Returns the new Group Connection

carrier_id
string<uuid>
required
read-only

Unique identifier of the carrier in Noyo

created
integer
required

The date the record was created

group_data
object
required

Carrier-specific data to execute a group connection

id
string<uuid>
required
read-only

Unique identifier of the group connection in Noyo

modified
integer
required

The date the record was last updated

organization_id
string<uuid>
required
read-only

Unique identifier of the platform or broker organization in Noyo

request_type
string
required
read-only

Type of the group connection

setup_result
object
required
read-only

More information about the result of the group connection

status
enum<string>
required
read-only

Status of the group connection

Available options:
created,
processing,
noyo_review,
waiting_on_carrier,
carrier_authorization,
action_required,
unable_to_connect,
completed
version
string<uuid>
required

Current version of the record

completed
integer
read-only

Timestamp indicating when a group connection was marked as completed.

federal_ein
string
read-only

Federal Employer Identification Number for the group

group_id
string<uuid>
read-only

ID of associated group model