v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

Group

Terminate group participation in networks

Terminates TenantGroupNetwork for the group and cascades to TenantGroupPractitionerNetwork and TenantGroupLocationNetwork only (CP-28229). Does not modify core group, practitioner, or location membership rows.

patch/groups/{groupId}/networks/terminate

Path parameters

groupIdstring required

ID of the group (certify group ID)

Headers

tenant-idstring

Request body

networkIdsstring[] required

Certify (core) network IDs to terminate the group from — same identifiers as other group/network APIs and Network.id in DAL.

terminationDatestring required

Termination date (ISO-8601, YYYY-MM-DD)

terminationInformedDatestring

Optional date the group was informed of termination (ISO-8601)

terminationReasonstring

Optional termination reason

Response

Successfully terminated group network participation

groupIdstring required

Certify group ID (same as the path parameter)

networkIdsstring[] required

Certify (core) network IDs that were processed (echo of the request)

tenantGroupNetworksTerminatedinteger required

Number of TenantGroupNetwork rows terminated

tenantGroupPractitionerNetworksTerminatedinteger required

Number of TenantGroupPractitionerNetwork rows terminated

tenantGroupLocationNetworksTerminatedinteger required

Number of TenantGroupLocationNetwork rows terminated