Skip to main content
PUT
Edit an existing Group Disconnection Request

Authorizations

Authorization
string
header
required

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

Path Parameters

group_disconnection_request_id
string<uuid>
required

The unique identifier of the group disconnection request you want to update

version
string<uuid>
required

The unique version of the group disconnection request you want to edit.

Body

application/json
status
enum<string>
required

The status of the disconnection request

Available options:
processing,
rejected
context
string

Context on why the request was rejected

effective_end_date
string<date>

The date at which the disconnection will take effect - required if not already set

reason
enum<string>

The reason for the GDR status change/creation

Available options:
connection_restored,
eligibility_restored,
other,
payment_reinstated

Response

200 - application/json

Successful Response - Returns the new GroupDisconnectionRequest

carrier_id
string<uuid>
required
read-only

Unique identifier for the carrier to be disconnected from

created
integer
required

The date the record was created

group_name
string
required
read-only

Name of the group to be disconnected from

id
string<uuid>
required

Unique identifier of the record in Noyo

modified
integer
required

The date the record was last updated

organization_id
string<uuid>
required
read-only

Unique identifier for organization associated with the request

source_id
string<uuid>
required
read-only

If applicable, the ID associated with the source of the disconnection request

source_type
string
required
read-only

The source of the disconnection request

status
string
required
read-only

The status of the disconnection request

version
string<uuid>
required

Current version of the record

completed
integer
read-only

Timestamp at which the disconnection was completed

decided
integer
read-only

Timestamp at which the platform recorded a decision on the disconnection

effective_end_date
string<date>
read-only

The date at which the disconnection will take effect

group_id
string<uuid>
read-only

Unique identifier for the group to be disconnected. May be missing if group has already been disconnected.

source_date
string<date>
read-only

The date associated with the source of the disconnection