latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Group

Add a specialty to a group

Adds a single specialty to an existing group, creating a group–specialty association. Optionally also adds the specialty to a specific group location and/or network in the same request via effective-date fields (groupSpecialtyEffectiveDate, groupLocationSpecialtyEffectiveDate, networkSpecialtyEffectiveDate). Supports effective-dating at creation but not termination-dating — use POST /groups/{id}/specialties/terminate to terminate a specialty. To add or update multiple specialties in a single call use PATCH /groups/{id}/specialties.

post/groups/{id}/specialties

Path parameters

idstring required

Group ID (certifyGroupId)

Headers

tenant-idstring

Request body

tenantSpecialtyIdstring required

ID of the tenant specialty

groupSpecialtyEffectiveDatestring

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

groupSpecialtyIsPrimaryboolean required

Indicates if the specialty is primary

tenantGroupLocationIdstring

ID of the tenant group location (optional)

groupLocationSpecialtyEffectiveDatestring

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

groupLocationSpecialtyIsPrimaryboolean

Indicates if the location specialty is primary

tenantGroupNetworkIdstring

ID of the tenant group network (optional)

networkSpecialtyEffectiveDatestring

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

networkSpecialtyIsPrimaryboolean

Indicates if the network specialty is primary

Example request

{
  "tenantSpecialtyId": "ts_123456",
  "groupSpecialtyEffectiveDate": "2024-01-01",
  "groupSpecialtyIsPrimary": true,
  "tenantGroupLocationId": "tgl_123456",
  "groupLocationSpecialtyEffectiveDate": "2024-01-01",
  "groupLocationSpecialtyIsPrimary": true,
  "tenantGroupNetworkId": "tgn_123456",
  "networkSpecialtyEffectiveDate": "2024-01-01",
  "networkSpecialtyIsPrimary": true
}

Response

Group specialty successfully created

object required