# Change an existing provider note Change an existing note associated with the specified provider. Endpoint: PUT /providers/{providerId}/notes/{noteId} Version: 26.2.0.4309 Security: Bearer ## Path parameters: - `providerId` (string, required) Identifier of the provider associated with the note to change. - `noteId` (string, required) Identifier of the note to be changed. ## Request fields (application/json): - `note` (string, required) The contents of the note. ## Response 200 fields (application/json): - `providerId` (string) Identifier of the provider related to this note. - `timestamp` (string) The date and time when this note was created or last changed. - `note` (string) The contents of the note. - `id` (string) Unique identifier for this note. - `alert` (object) - `alert.type` (string) The type of event that led to this alert. Enum: "LicenseChanged", "LicenseExpiresSoon", "LicenseExpired", "ProfileImportCompleted" - `alert.providerId` (string) Identifier of the provider related to this alert. - `alert.provider` (object) - `alert.provider.id` (string) Unique identifier associated with this provider. - `alert.provider.firstName` (string, required) The first (given) name associated with this provider. - `alert.provider.lastName` (string, required) The last (family) name associated with this provider. - `alert.provider.dateOfBirth` (string) The date of birth of this provider. - `alert.provider.ssn` (string) The social security number of this provider. - `alert.provider.credentialingStatus` (string, required) The name of credentialing status. The default value is 'Data Collection'. - `alert.provider.credentialedDate` (string) Date this provider was originally credentialed - `alert.provider.nextCredentialingDate` (string) Date this provider should be credentialed next - `alert.provider.npi` (integer) The 10 digit National Provider Identifiers (NPI) of this provider. - `alert.provider.deactivated` (boolean) If set, the provider is deactivated. Verifications and profile imports can't be triggered for the inactive provider. - `alert.provider.deactivatedAt` (string) - `alert.provider.aliases` (array) A list of aliases that this provider is also known by. - `alert.provider.aliases.firstName` (string) The first (given) name of this alias. - `alert.provider.aliases.lastName` (string) The last (family) name of this alias. - `alert.provider.aliases.id` (string) Unique identifier for this alias. - `alert.provider.primaryPracticeState` (string) The primary practice state of the provider. Enum: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "GU", "MP", "PR", "VI" - `alert.provider.additionalPracticeStates` (array) Additional practice states of the provider. Cannot include the primary practice state. Enum: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "GU", "MP", "PR", "VI" - `alert.provider.gender` (string) Provider's gender (optional). Enum: "Unknown", "Male", "Female", "NonBinaryOrThirdGender", "Other", "PreferNotToSay" - `alert.provider.ethnicity` (array) Provider's ethnicity (optional). Enum: "AmericanIndianOrAlaskaNative", "Asian", "BlackOrAfricanAmerican", "HispanicOrLatino", "NativeHawaiianOrOtherPacificIslander", "White", "PreferNotToSay", "NoInformationToAnswer" - `alert.provider.addresses` (array) If set, the provider's addresses will be updated with this value. To remove the addresses pass an empty array. - `alert.provider.addresses.state` (string, required) Abbreviation of the state in which the city is located. Enum: "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "GU", "MP", "PR", "VI" - `alert.provider.addresses.zipCode` (string, required) The postal code associated with the address. - `alert.provider.addresses.city` (string, required) The city in which the address is located. - `alert.provider.addresses.addressLine1` (string, required) The street address. - `alert.provider.addresses.addressLine2` (string) The secondary address information. - `alert.provider.addresses.type` (string) The type of address. Enum: "Unspecified", "Home", "Work" - `alert.provider.addresses.id` (string) Unique identifier for this address. - `alert.provider.emails` (array) If set, the provider's emails will be updated with this value. To remove the emails pass an empty array. - `alert.provider.emails.email` (string) The email associated with the provider. - `alert.provider.emails.type` (string) The type of the email. Enum: "Unspecified", "Personal", "Work" - `alert.provider.emails.id` (string) Unique identifier for this specific email. - `alert.provider.phone` (string) Primary phone number associated with this provider - `alert.provider.languages` (array) A list of languages, other than English, this provider speaks. - `alert.provider.recredentialedDates` (array) A list of dates when this provider was re-credentialed. - `alert.provider.providerType` (object) - `alert.provider.providerType.id` (string) Unique identifier associated with this provider type. - `alert.provider.providerType.name` (string) Associated provider type name. - `alert.provider.segment` (object) Example: {"id":"3516a6ba-c998-4bfb-9017-322f8cf63674","name":"acme-corp"} - `alert.provider.segment.id` (string) Unique identifier of the segment. Example: "3516a6ba-c998-4bfb-9017-322f8cf63674" - `alert.provider.segment.name` (string) Name of the segment. Used for multi-tenant organizations for billing, configuration, and tracking purposes. Example: "acme-corp" - `alert.provider.createdAt` (string) Timestamp when this provider was created. - `alert.entityType` (string) If set, the type of the entity that EntityId refers to. Enum: "License", "Verification", "Alert", "NpiRecord", "Note", "BoardCertification", "BoardCertificationVerification", "DeaVerification", "DatasetScan", "DatasetRecord", "File", "ProfileImport", "NpdbVerificationRequest" - `alert.entityId` (string) Identifier of the related entity that's relevant to this alert type. - `alert.data` (object) - `alert.data.messageTemplate` (string) An informative human readable message describing the action in the audit log entry. - `alert.data.messageParams` (object) Collection of key/value pairs containing parameters to be replaced in messageTemplate. - `alert.timestamp` (string) The date and time when this alert was triggered. - `alert.dismissalTimestamp` (string) The date and time when this alert was dismissed, if at all. - `alert.dismissalNote` (string) The note supplied as reason for dismissal, if and when this alert was dismissed. - `alert.id` (string) Unique identifier for this alert. ## Response 400 fields ## Response 401 fields ## Response 403 fields ## Response 404 fields ## Response 409 fields ## Response 500 fields