> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.joincandidhealth.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.joincandidhealth.com/_mcp/server. # Update organization provider PATCH https://api.joincandidhealth.com/api/organization-providers/v3/{organization_provider_id} Content-Type: application/json Reference: https://docs.joincandidhealth.com/api-reference/organization-providers/v-3/update ## Authentication - OAuth2 — send the obtained token as `Authorization: Bearer ` ## Servers - `https://api.joincandidhealth.com` (Production, default) - `https://api-staging.joincandidhealth.com` (Staging) - `https://sandbox-api.joincandidhealth.com` (CandidSandbox) - `https://staging-api.joincandidhealth.com` (CandidStaging) - `http://localhost:5050` (Local) ## Request ### Path parameters - `organization_provider_id` (UUID, required) ### Body (application/json) This endpoint expects an OrganizationProviderUpdateV2. - `npi` (string, optional) — The NPI of the provider. This must be all digits [0-9] and exactly 10 characters long. - `is_rendering` (boolean, optional) — Whether the provider can be used to render services. - `is_billing` (boolean, optional) — Whether the provider can be used to bill services. - `first_name` (string, optional) — The first name of the provider, if the provider is an individual. - `last_name` (string, optional) — The last name of the provider, if the provider is an individual. - `organization_name` (string, optional) — The name of the provider, if the provider is an organization. - `provider_type` (enum, optional) — Whether the provider is an individual (NPPES Type 1) or organization (NPPES Type 2) provider. - Allowed values: `INDIVIDUAL`, `ORGANIZATION` - `tax_id` (string, optional) — If the provider has a contract with insurance, this must be the same tax ID given to the payer on an IRS W-9 form completed during contracting. - `taxonomy_code` (string, optional) — A code designating classification and specialization. - `license_type` (enum, optional) — The type of license that the provider holds. - Allowed values: `MD`, `NP`, `PA`, `LMFT`, `LCPC`, `LCSW`, `PMHNP`, `FNP`, `LPCC`, `DO`, `RD`, `SLP`, `APRN`, `LPC`, `PHD`, `PSYD`, `LMSW`, `LMHC`, `OTHER_MASTERS`, `BCBA`, `UNKNOWN`, `RPH`, `PHT`, `LAC`, `LMT`, `DC`, `ND`, `MA`, `PT`, `IBCLC`, `RN`, `DPT`, `LCMHC`, `CNM`, `RNFA`, `ACSW`, `APC`, `BCABA`, `BHA`, `OD`, `DPM`, `DA`, `DDS`, `DEH`, `DMD`, `PTA`, `LCADC`, `LCAT`, `LCMHCS`, `LCMHCA`, `LCSWA`, `LICSW`, `LISW`, `LMFTS`, `LMFTA`, `LPCI`, `LSCSW`, `MHCA`, `MHT`, `RBT`, `RCSWI`, `RHMCI`, `LPN`, `OTD`, `OMS`, `MFTA`, `APCC`, `DNP`, `AGNPBC`, `ANP`, `FNPPP`, `LCSWR`, `ALC`, `RMFTI`, `LAMFT`, `LPCA`, `LSWI`, `CSW`, `CPC`, `LGMFT`, `LLPC`, `PLPC`, `PLMFT`, `LMHCA`, `CIT`, `CT`, `MFT`, `LSW`, `PLMHP`, `PCMSW`, `LMHP`, `OTR/L`, `RPA`, `COTA`, `CRNP`, `SLP-CF`, `NP-C`, `PA-C`, `AMFT`, `CDN`, `CGC`, `CNS`, `MDPHD`, `AuD`, `ATC`, `LAT`, `OTA`, `LSSP`, `SLPA`, `EdD`, `SWT`, `IMFT` - `addresses` (list of OrganizationProviderAddress, optional) — The addresses associated with this provider. - `employment_start_date` (string, optional) — The employment start date for the provider. - `employment_termination_date` (string, optional) — The employment termination date for the provider. - `qualifications` (list of UpdatableIdentifier, optional) — Provider's qualifications (medicare provider number, medicaid provider number, etc.) ## Response ### 200 - `npi` (string, required) — The NPI of the provider. This must be all digits [0-9] and exactly 10 characters long. - `is_rendering` (boolean, required) — Whether the provider can be used to render services. - `is_billing` (boolean, required) — Whether the provider can be used to bill services. - `provider_type` (enum, required) — Whether the provider is an individual (NPPES Type 1) or organization (NPPES Type 2) provider. - Allowed values: `INDIVIDUAL`, `ORGANIZATION` - `license_type` (enum, required) — The type of license that the provider holds. - Allowed values: `MD`, `NP`, `PA`, `LMFT`, `LCPC`, `LCSW`, `PMHNP`, `FNP`, `LPCC`, `DO`, `RD`, `SLP`, `APRN`, `LPC`, `PHD`, `PSYD`, `LMSW`, `LMHC`, `OTHER_MASTERS`, `BCBA`, `UNKNOWN`, `RPH`, `PHT`, `LAC`, `LMT`, `DC`, `ND`, `MA`, `PT`, `IBCLC`, `RN`, `DPT`, `LCMHC`, `CNM`, `RNFA`, `ACSW`, `APC`, `BCABA`, `BHA`, `OD`, `DPM`, `DA`, `DDS`, `DEH`, `DMD`, `PTA`, `LCADC`, `LCAT`, `LCMHCS`, `LCMHCA`, `LCSWA`, `LICSW`, `LISW`, `LMFTS`, `LMFTA`, `LPCI`, `LSCSW`, `MHCA`, `MHT`, `RBT`, `RCSWI`, `RHMCI`, `LPN`, `OTD`, `OMS`, `MFTA`, `APCC`, `DNP`, `AGNPBC`, `ANP`, `FNPPP`, `LCSWR`, `ALC`, `RMFTI`, `LAMFT`, `LPCA`, `LSWI`, `CSW`, `CPC`, `LGMFT`, `LLPC`, `PLPC`, `PLMFT`, `LMHCA`, `CIT`, `CT`, `MFT`, `LSW`, `PLMHP`, `PCMSW`, `LMHP`, `OTR/L`, `RPA`, `COTA`, `CRNP`, `SLP-CF`, `NP-C`, `PA-C`, `AMFT`, `CDN`, `CGC`, `CNS`, `MDPHD`, `AuD`, `ATC`, `LAT`, `OTA`, `LSSP`, `SLPA`, `EdD`, `SWT`, `IMFT` - `organization_provider_id` (UUID, required) — Auto-generated ID set on creation. - `qualifications` (list of Identifier, required) — Qualification given to a provider (PTAN, Medicaid Provider Id etc.). - `first_name` (string, optional) — The first name of the provider, if the provider is an individual. - `last_name` (string, optional) — The last name of the provider, if the provider is an individual. - `organization_name` (string, optional) — The name of the provider, if the provider is an organization. - `tax_id` (string, optional) — If the provider has a contract with insurance, this must be the same tax ID given to the payer on an IRS W-9 form completed during contracting. - `taxonomy_code` (string, optional) — A code designating classification and specialization. - `addresses` (list of OrganizationProviderAddress, optional) — The addresses associated with this provider. - `employment_start_date` (date, optional) — The employment start date for the provider. - `employment_termination_date` (date, optional) — The employment termination date for the provider. ## Errors ### 422 HTTP Request Validation Error - `errorName` ("HttpRequestValidationError", required) - `content` (RequestValidationError, required) ### 404 Entity Not Found Error - `errorName` ("EntityNotFoundError", required) - `content` (EntityNotFoundErrorMessage, required) ### 422 Updates Disabled Due to External System Integration Error - `errorName` ("UpdatesDisabledDueToExternalSystemIntegrationError", required) - `content` (UpdatesDisabledDueToExternalSystemIntegrationErrorMessage, required) ## Types ### OrganizationProviderAddress - `address` (StreetAddressLongZip, required) — The address of the provider - `address_type` (enum, required) — The address type of the provider - Allowed values: `DEFAULT` ### UpdatableIdentifier - `type`: `add` - `identifier_code` (enum, required) - Allowed values: `MCR`, `MCD` - `identifier_value` (IdentifierValue, required) - `period` (DateRangeOptionalEnd, optional) - `type`: `update` - `identifier_id` (UUID, required) - `identifier_code` (enum, optional) - Allowed values: `MCR`, `MCD` - `identifier_value` (IdentifierValue, optional) - `period` (RemovableDateRangeOptionalEnd, optional) - `type`: `remove` - `value` (UUID, required) ### Identifier - `identifier_code` (enum, required) - Allowed values: `MCR`, `MCD` - `identifier_id` (UUID, required) - `identifier_value` (IdentifierValue, required) - `period` (DateRangeOptionalEnd, optional) ### RequestValidationError - `fieldName` (string, required) - `humanReadableMessage` (string, optional) ### EntityNotFoundErrorMessage - `id` (string, required) ### UpdatesDisabledDueToExternalSystemIntegrationErrorMessage - `message` (string, optional) ### StreetAddressLongZip - `address1` (string, required) - `city` (string, required) - `state` (enum, required) - Allowed values: `AA`, `AE`, `AP`, `AL`, `AK`, `AS`, `AZ`, `AR`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `ID`, `IL`, `IN`, `IA`, `KS`, `KY`, `LA`, `ME`, `MD`, `MA`, `MH`, `MI`, `MN`, `MP`, `MS`, `MO`, `MT`, `NE`, `NV`, `NH`, `NJ`, `NM`, `NY`, `NC`, `ND`, `OH`, `OK`, `OR`, `PA`, `PR`, `PW`, `RI`, `SC`, `SD`, `TN`, `TX`, `UT`, `VI`, `VT`, `VA`, `WA`, `WV`, `WI`, `WY`, `FC` - `zip_code` (string, required) — 5-digit zip code - `zip_plus_four_code` (string, required) — 4-digit zip add-on code https://en.wikipedia.org/wiki/ZIP_Code#ZIP+4 - `address2` (string, optional) ### IdentifierValue - `type`: `medicare_provider_identifier` - `provider_number` (string, required) - `state` (enum, required) - Allowed values: `AA`, `AE`, `AP`, `AL`, `AK`, `AS`, `AZ`, `AR`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `ID`, `IL`, `IN`, `IA`, `KS`, `KY`, `LA`, `ME`, `MD`, `MA`, `MH`, `MI`, `MN`, `MP`, `MS`, `MO`, `MT`, `NE`, `NV`, `NH`, `NJ`, `NM`, `NY`, `NC`, `ND`, `OH`, `OK`, `OR`, `PA`, `PR`, `PW`, `RI`, `SC`, `SD`, `TN`, `TX`, `UT`, `VI`, `VT`, `VA`, `WA`, `WV`, `WI`, `WY`, `FC` - `organization_service_facility_id` (UUID, optional) — When set, this identifier applies only to the given service facility. - `type`: `medicaid_provider_identifier` - `provider_number` (string, required) - `state` (enum, required) - Allowed values: `AA`, `AE`, `AP`, `AL`, `AK`, `AS`, `AZ`, `AR`, `CA`, `CO`, `CT`, `DC`, `DE`, `FL`, `FM`, `GA`, `GU`, `HI`, `ID`, `IL`, `IN`, `IA`, `KS`, `KY`, `LA`, `ME`, `MD`, `MA`, `MH`, `MI`, `MN`, `MP`, `MS`, `MO`, `MT`, `NE`, `NV`, `NH`, `NJ`, `NM`, `NY`, `NC`, `ND`, `OH`, `OK`, `OR`, `PA`, `PR`, `PW`, `RI`, `SC`, `SD`, `TN`, `TX`, `UT`, `VI`, `VT`, `VA`, `WA`, `WV`, `WI`, `WY`, `FC` - `organization_service_facility_id` (UUID, optional) — When set, this identifier applies only to the given service facility. ### DateRangeOptionalEnd - `start_date` (string, required) — ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) - `end_date` (string, optional) — ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) ### RemovableDateRangeOptionalEnd - `type`: `date_range` - `start_date` (string, required) — ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) - `end_date` (string, optional) — ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01) - `type`: `remove` ## Examples **Request** ```json {} ``` **Response** ```json { "npi": "npi", "is_rendering": true, "is_billing": true, "provider_type": "INDIVIDUAL", "license_type": "MD", "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "qualifications": [ { "identifier_code": "MCR", "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "identifier_value": { "type": "medicare_provider_identifier", "provider_number": "provider_number", "state": "AA", "organization_service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, "period": { "start_date": "start_date", "end_date": "end_date" } }, { "identifier_code": "MCR", "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "identifier_value": { "type": "medicare_provider_identifier", "provider_number": "provider_number", "state": "AA", "organization_service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, "period": { "start_date": "start_date", "end_date": "end_date" } } ], "first_name": "first_name", "last_name": "last_name", "organization_name": "organization_name", "tax_id": "tax_id", "taxonomy_code": "taxonomy_code", "addresses": [ { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "address_type": "DEFAULT" }, { "address": { "address1": "address1", "city": "city", "state": "AA", "zip_code": "zip_code", "zip_plus_four_code": "zip_plus_four_code", "address2": "address2" }, "address_type": "DEFAULT" } ], "employment_start_date": "2023-01-15", "employment_termination_date": "2023-01-15" } ``` **SDK Code** ```python import requests url = "https://api.joincandidhealth.com/api/organization-providers/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" payload = {} headers = { "Authorization": ".", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.joincandidhealth.com/api/organization-providers/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32'; const options = { method: 'PATCH', headers: {Authorization: '.', 'Content-Type': 'application/json'}, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.joincandidhealth.com/api/organization-providers/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" payload := strings.NewReader("{}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("Authorization", ".") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.joincandidhealth.com/api/organization-providers/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = '.' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.joincandidhealth.com/api/organization-providers/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") .header("Authorization", ".") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('PATCH', 'https://api.joincandidhealth.com/api/organization-providers/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', [ 'body' => '{}', 'headers' => [ 'Authorization' => '.', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.joincandidhealth.com/api/organization-providers/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "."); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": ".", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.joincandidhealth.com/api/organization-providers/v3/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```