Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Group

Update a group

Updates an existing group based on the group ID.

put/groups/{id}

Path parameters

idstring required

Group ID

Headers

tenant-idstring

Request body

certifyGroupIdstring

Primary key - Certify Group ID

sourceIdstring

Foreign key - Source ID

crosswalkIdstring

Foreign key - Crosswalk ID

affiliationstring

Group affiliation

npistring

National Provider Identifier

namestring

Group name

parentHealthcareOrgstring

Parent healthcare organization ID

tinstring

Tax Identification Number

typestring

Group type

legalTaxNamestring

Legal tax name

activeboolean

Whether the group is active

telemedicineAvailableboolean

Whether telemedicine is available

bedCountinteger

Number of beds

deastring

DEA number

specialtyIdsstring[]

Specialty IDs to associate with the group (consistent with create practitioner pattern)

groupEffectiveDatestring date
externalGroupIdstring

External group ID from tenant system

npdbEnrollmentEnabledboolean

Whether NPDB enrollment is enabled

createdAtstring date-time
createdBystring

Foreign key - Created by User ID

Example request

{
  "certifyGroupId": "group-12345",
  "sourceId": "tenant:tenant-123",
  "crosswalkId": "1234567890",
  "affiliation": "Medical Group",
  "npi": "1234567890",
  "name": "Acme Medical Group",
  "contacts": [
    {
      "name": "Jane Smith",
      "email": "jane@example.com",
      "phone": "555-123-4567",
      "title": "Credentialing Manager"
    }
  ],
  "parentHealthcareOrg": "org-12345",
  "tin": "12-3456789",
  "type": "Medical Group",
  "legalTaxName": "Acme Medical Group LLC",
  "active": true,
  "telemedicineAvailable": true,
  "taxInfo": {
    "billingTin": "12-3456789",
    "billingNpi": "1234567890"
  },
  "bedCount": 50,
  "dea": "AB1234567",
  "groupEffectiveDate": "2022-03-10",
  "externalGroupId": "ext-group-123",
  "credentialingContact": {
    "name": "Jane Smith",
    "email": "jane@example.com",
    "phone": "555-123-4567",
    "title": "Credentialing Manager",
    "department": "Credentialing"
  },
  "npdbEnrollmentEnabled": true,
  "createdBy": "user-12345",
  "addresses": [
    {
      "addressType": "billing",
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 100",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "county": "New York County",
      "country": "US",
      "isPrimary": true
    }
  ]
}

Response

Group successfully updated

certifyIdstring

Primary key - Certify Group ID

crosswalkIdstring

Crosswalk ID

sourceIdstring

Source ID

sourceUrlstring

Source URL

sourceTypestring

Source type

sourceNamestring

Source name

sourceDescriptionstring

Source description

survivorIdstring

Survivor ID

tenantGroupIdstring

Tenant Group ID (legacy)

lastUpdatedstring date-time

Example response

{
  "certifyId": "group-12345",
  "crosswalkId": "1234567890",
  "sourceId": "tenant:tenant-123",
  "sourceUrl": "https://api.example.com",
  "sourceType": "tenant",
  "sourceName": "Tenant System",
  "sourceDescription": "Internal tenant system",
  "survivorId": "survivor-123",
  "addresses": [
    {
      "addressType": "billing",
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 100",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "county": "New York County",
      "country": "US",
      "isPrimary": true
    }
  ],
  "addressesCopy": [
    {
      "addressType": "billing",
      "addressLine1": "123 Main Street",
      "addressLine2": "Suite 100",
      "city": "New York",
      "state": "NY",
      "zip": "10001",
      "county": "New York County",
      "country": "US",
      "isPrimary": true
    }
  ]
}