v1

latestOpenAPI 3.1.02026-08-063776831.4 MB

Group

Update a group specialty

Updates the effective date and/or termination date of an existing group specialty.

put/groups/{id}/specialties

Path parameters

idstring required

Group ID

Headers

tenant-idstring

Request body

tenantGroupSpecialtyIdstring required

ID of the tenant group specialty to update

effectiveDatestring

Effective date for the group specialty (YYYY-MM-DD)

terminationDatestring

Termination date for the group specialty (YYYY-MM-DD)

groupPractitionerLocationSpecialtiesstring[]

Group practitioner location specialties to update

tenantGroupPractitionerLocationNetworkSpecialtiesstring[]

Tenant group practitioner location network specialties to update

tenantGroupPractitionerNetworkParticipationSpecialtiesstring[]

Tenant group practitioner network participation specialties to update

tenantGroupNetworkSpecialtiesstring[]

Tenant group network specialties to update

tenantGroupLocationNetworkSpecialtiesstring[]

Tenant group location network specialties to update

tenantGroupFacilityLocationNetworkSpecialtiesstring[]

Tenant group facility locationnetwork specialties to update

tenantGroupFacilityNetworkSpecialtiesstring[]

Tenant group facility network specialties to update

tenantGroupLocationSpecialtiesstring[]

Tenant group location specialties to update

tenantGroupPractitionerSpecialtiesstring[]

Tenant group practitioner specialties to update

tenantGroupFacilitySpecialtiesstring[]

Tenant group facility specialties to update

Example request

{
  "tenantGroupSpecialtyId": "tgs_123456",
  "effectiveDate": "2024-01-01",
  "terminationDate": "2024-12-31",
  "groupPractitionerLocationSpecialties": [
    "tenantgrouppractitionerlocationspecialty_1"
  ],
  "tenantGroupPractitionerLocationNetworkSpecialties": [
    "tenantgrouppractitionerlocationnetworkspecialty_1"
  ],
  "tenantGroupPractitionerNetworkParticipationSpecialties": [
    "tenantgrouppractitionernetworkparticipationspecialty_1"
  ],
  "tenantGroupNetworkSpecialties": [
    "tenantgroupnetworkspecialty_1"
  ],
  "tenantGroupLocationNetworkSpecialties": [
    "tenantgrouplocationparticipationspecialty_1"
  ],
  "tenantGroupFacilityLocationNetworkSpecialties": [
    "tenantgroupfacilitylocationnetworkspecialty_1"
  ],
  "tenantGroupFacilityNetworkSpecialties": [
    "tenantgroupfacilitynetworkspecialty_1"
  ],
  "tenantGroupLocationSpecialties": [
    "tenantgrouplocationspecialty_1"
  ],
  "tenantGroupPractitionerSpecialties": [
    "tenantgrouppractitionerspecialty_1"
  ],
  "tenantGroupFacilitySpecialties": [
    "tenantgroupfacilityspecialty_1"
  ]
}

Response

Group specialty successfully updated

emptyboolean

valueNodeboolean

containerNodeboolean

missingNodeboolean

arrayboolean

objectboolean

pojoboolean

numberboolean

integralNumberboolean

floatingPointNumberboolean

shortboolean

intboolean

longboolean

floatboolean

doubleboolean

bigDecimalboolean

bigIntegerboolean

textualboolean

booleanboolean

nullboolean

binaryboolean