Skip to main content
PUT
/
api
/
v1
/
group_disconnection_requests
/
{group_disconnection_request_id}
/
{version}
Edit an existing Group Disconnection Request
curl --request PUT \
  --url https://fulfillment.noyo.com/api/v1/group_disconnection_requests/{group_disconnection_request_id}/{version} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "processing",
  "context": "<string>",
  "effective_end_date": "2023-12-25",
  "reason": "connection_restored"
}
'
{
  "carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": 123,
  "group_name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modified": 123,
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_type": "<string>",
  "status": "<string>",
  "version": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "completed": 123,
  "decided": 123,
  "effective_end_date": "2023-12-25",
  "group_id": "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_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

Unique identifier for the carrier to be disconnected from

​
created
integer
required

The date the record was created

​
group_name
string
required

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

Unique identifier for organization associated with the request

​
source_id
string<uuid>
required

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

​
source_type
string
required

The source of the disconnection request

​
status
string
required

The status of the disconnection request

​
version
string<uuid>
required

Current version of the record

​
completed
integer

Timestamp at which the disconnection was completed

​
decided
integer

Timestamp at which the platform recorded a decision on the disconnection

​
effective_end_date
string<date>

The date at which the disconnection will take effect

​
group_id
string<uuid>

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