Skip to main content
PATCH
/
v1
/
credentialing
/
{id}
Update Credentialing Record
curl --request PATCH \
  --url https://api.example.com/v1/credentialing/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "type": "entity",
  "npi": "<string>",
  "tax_id": "<string>",
  "is_active": true,
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "therapist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "insurance_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "type": "entity",
  "npi": "<string>",
  "is_active": true,
  "created_at": "<string>",
  "updated_at": "<string>",
  "tax_id": "<string>",
  "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "therapist_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "insurances": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "is_active": true,
      "payer_id": "<string>",
      "trading_partner_service_id": "<string>"
    }
  ],
  "location": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip_code": "<string>"
  }
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
id
string
required

Body

application/json

Schema for updating a credentialing record.

​
name
string | null
Required string length: 1 - 255
​
type
enum<string> | null

Credentialing type enum matching Prisma

Available options:
entity,
rendering_provider
​
npi
string | null
Required string length: 10
​
tax_id
string | null
​
is_active
boolean | null
​
location_id
string<uuid> | null
​
therapist_id
string<uuid> | null
​
insurance_ids
string<uuid>[] | null

Response

Successful Response

Response schema for a credentialing record.

​
id
string<uuid>
required
​
company_id
string<uuid>
required
​
name
string
required
​
type
enum<string>
required

Credentialing type enum matching Prisma

Available options:
entity,
rendering_provider
​
npi
string
required
​
is_active
boolean
required
​
created_at
string
required
​
updated_at
string
required
​
tax_id
string | null
​
location_id
string<uuid> | null
​
therapist_id
string<uuid> | null
​
insurances
CredentialingInsuranceResponse · object[] | null
​
location
CredentialingLocationResponse · object

Nested location object for credentialing response.