latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Group

Create a new group for the tenant

Creates a new group record scoped to the requesting tenant. The request body must supply at least one of npi or externalGroupId; email is validated and returns 400 if malformed, but no other fields are currently enforced by request validation (schema validation is disabled for this endpoint). Not idempotent — repeated calls with identical payloads create duplicate group records. Note: the parentHealthcareOrgId query parameter is currently accepted but has no effect on the created group regardless of the value supplied.

post/groups

Query parameters

parentHealthcareOrgIdstring

Parent healthcare organization ID. Currently accepted but not used — has no effect on the created group.

Headers

tenant-idstring

Request body

namestring

Group name

npistring

National Provider Identifier

tinstring

Tax Identification Number

specialtyIdsstring[]

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

groupEffectiveDatestring date

externalGroupIdstring

External group ID from tenant system

contactPersonobject

Contact person information as JSON

activeboolean

Whether the tenant group is currently active

npdbEnrollmentEnabledboolean

Whether NPDB enrollment is enabled

credentialingDelegationboolean

Whether credentialing is delegated

Example request

{
  "name": "Acme Medical Group",
  "npi": "1234567890",
  "tin": "12-3456789",
  "contacts": [
    {
      "name": "Jane Smith",
      "email": "jane@example.com",
      "phone": "555-123-4567",
      "title": "Credentialing Manager"
    }
  ],
  "groupEffectiveDate": "2022-03-10",
  "externalGroupId": "ext-group-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
    }
  ],
  "networks": [
    {
      "networkName": "Blue Cross Blue Shield Network",
      "networkType": "Commercial",
      "networkEffectiveDate": "2024-01-01",
      "networkGroupStatus": "active",
      "networkGroupTerminationDate": "2025-12-31"
    }
  ],
  "contactPerson": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "555-123-4567"
  },
  "active": true,
  "npdbEnrollmentEnabled": true,
  "credentialingDelegation": true
}

Response

Group successfully created

idstring

crosswalkIdstring