Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Group

Merge updated data into a group by ID

Merges the supplied fields into an existing group identified by its certifyGroupId — an UPSERT_DATA merge, not a full replace; omitted fields are preserved on the existing record rather than cleared. Updatable fields include the group's core attributes and tax information; taxInfo.billingTin, taxInfo.billingNpi, and email are validated and return 400 if malformed. Use this endpoint for non-legacy group updates — for groups sourced from an external system and identified by source type and crosswalk ID, use the deprecated PUT /groups/{sourceType}/{crosswalkId} instead. Every call publishes an audit event, even when the merged data is identical to the existing record (no database row update occurs in that case, but the audit event is still emitted).

put/groups/{id}

Path parameters

idstring required

Group ID (certifyGroupId)

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

emailstring

Group Overview email address — an email with no associated contact type (CP-35967). Distinct from contacts[] entries and from the typed contractingContact/officeManager/credentialingContact emails.

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

contactPersonobject

Contact person information as JSON

userDefinedFieldsobject

Custom user-defined fields. Replaces the entire userDefinedFields object (PUT semantics).

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",
  "email": "group@example.com",
  "active": true,
  "telemedicineAvailable": true,
  "taxInfo": {
    "billingTin": "12-3456789",
    "billingNpi": "1234567890"
  },
  "bedCount": 50,
  "dea": "AB1234567",
  "groupEffectiveDate": "2022-03-10",
  "externalGroupId": "ext-group-123",
  "contactPerson": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "555-123-4567"
  },
  "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

groupDataobject

Complete group data

dataobject

Raw data object (legacy)

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
    }
  ]
}