Update | Candid | API Reference

curl -X PUT https://pre-api.joincandidhealth.com/organization-external-providers/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32/version \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": {
    "family": "family",
    "given": [
      "given",
      "given"
    ],
    "use": "USUAL"
  },
  "types": [
    "REFERRING",
    "REFERRING"
  ]
}'

{
  "deactivated": true,
  "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "name": {
    "family": "family",
    "given": [
      "given",
      "given"
    ],
    "use": "USUAL",
    "period": {
      "start": "2023-01-15",
      "end": "2023-01-15"
    },
    "suffix": "suffix"
  },
  "organization_id": "organization_id",
  "types": [
    "REFERRING",
    "REFERRING"
  ],
  "updated_at": "2024-01-15T09:30:00Z",
  "updating_user_id": "updating_user_id",
  "version": 1,
  "addresses": [
    {
      "use": "HOME",
      "line": [
        "line",
        "line"
      ],
      "city": "city",
      "state": "state",
      "postal_code": "postal_code",
      "country": "country",
      "period": {
        "start": "2023-01-15",
        "end": "2023-01-15"
      }
    },
    {
      "use": "HOME",
      "line": [
        "line",
        "line"
      ],
      "city": "city",
      "state": "state",
      "postal_code": "postal_code",
      "country": "country",
      "period": {
        "start": "2023-01-15",
        "end": "2023-01-15"
      }
    }
  ],
  "fax_number": "fax_number",
  "license_type": "MD",
  "npi": "npi",
  "phone_number": "phone_number",
  "tax_id": "tax_id",
  "taxonomy_code": "taxonomy_code"
}

Updates an organization external provider. The path must contain the next version number to prevent race conditions. For example, if the current version of the provider is n, you will need to send a request to this endpoint with /{id}/n+1 to update the provider. Updating historic versions is not supported. BadRequestError is returned when the NPI is already in use by another provider.

Updates an organization external provider. The path must contain the next version number to prevent race conditions. For example, if the current version of the provider is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the provider. Updating historic versions is not supported. BadRequestError is returned when the NPI is already in use by another provider.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

idUUIDRequired

The unique identifier for an OrganizationExternalProvider in the database

versionstringRequired

Request

This endpoint expects an object.

nameobjectRequired

typeslist of enumsRequired

Allowed values:

npistringOptional

tax_idstringOptional

taxonomy_codestringOptional

phone_numberstringOptional

fax_numberstringOptional

license_typeenumOptional

addresseslist of objectsOptional

Response

This endpoint returns an object.

deactivatedboolean

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

idUUID

The unique identifier for an OrganizationExternalProvider in the database

nameobject

organization_idstring

The organization that owns this object.

typeslist of enums

Allowed values:

updated_atdatetime

updating_user_idstring

The user ID of the user who last updated the object.

versioninteger

The version of the object. Any update to any property of an object object will create a new version.

addresseslist of objects

fax_numberstring

license_typeenum

npistring

phone_numberstring

tax_idstring

taxonomy_codestring

Errors

400

Bad Request Error

404

Not Found Error

409

Version Conflict Error