Sign in

v1

latestOpenAPI 3.1.02026-07-1382339.6 KB
Onboarding
Onboarding

Update Client Onboarding Details

Update the onboarding configuration of an existing FHIR client. Use Agencies for FhirProvider / FhirAggregator / FhirThirdParty mapping updates, or Payer (exactly one item) for FhirPayer clients. In Swagger, open Request body → Examples to load provider vs payer sample JSON.

patch/v1/fhir-onboarding/client/{client_id}

Path parameters

client_idstring required

Unique identifier of the client whose onboarding configuration is being updated

Unique identifier of the client whose onboarding configuration is being updated

Request body

Descriptionstring nullable

Client description

RateLimitingPlanstring nullable

Rate limiting plan (Basic, Premium) - case insensitive

Statusstring nullable

Client status (Active, Inactive) - case insensitive

Example request

{
  "Agencies": [
    {
      "AgencyId": 123,
      "Env": "app",
      "RateLimit": 100,
      "RateLimitWindow": "Second"
    },
    {
      "AgencyId": 678
    }
  ],
  "Description": "HHAx Client",
  "RateLimitingPlan": "Premium",
  "Status": "Inactive"
}

Response

Successful Response

Messagestring required

Response message

Example response

{
  "Data": {
    "AgencyUsers": [
      {
        "AgencyId": 123,
        "Env": "app",
        "ProviderTaxId": "12-3456789",
        "RateLimit": 50,
        "RateLimitWindow": "Minute",
        "UserId": -6789,
        "UserName": "FHIRAPIUser_1_123"
      },
      {
        "AgencyId": 678,
        "Env": "app2",
        "RateLimit": 50,
        "RateLimitWindow": "Minute",
        "UserId": -4567,
        "UserName": "FHIRAPIUser_1_678"
      },
      {
        "AgencyId": 789,
        "Env": "cloud",
        "RateLimit": 100,
        "RateLimitWindow": "Second",
        "UserId": -8765,
        "UserName": "FHIRAPIUser_1_789"
      }
    ],
    "ClientId": "9b2f1a6e-3c84-4d8e-9b8a-7e2c9f2a1c45",
    "ClientName": "Client 1",
    "ClientType": "FhirProvider",
    "CreatedAt": "2026-02-02T14:28:18.479016Z",
    "Description": "HHAx Client Updated",
    "RateLimitingPlan": "Premium",
    "Status": "Active",
    "UpdatedAt": "2026-02-02T09:25:11.102958Z",
    "XApiKey": "brcRWv6qZQanfxwoZYvuYpMpfTUsvxEnkli2n998"
  },
  "Message": "Client onboarding details updated successfully"
}