Update Provider

Updates an existing provider's information. Note that NPI and tax ID cannot be changed after creation.

POST/providers/{providerId}
This is a beta endpoint. We may make backwards incompatible changes.

This endpoint allows you to update information for an existing provider. For example, you may want to add an additional contact.

Please note:

  • Calling this endpoint completely overwrites the previous request record. You must provide all the information for the provider in the request, not just the properties you want to update.
  • Updating a provider record doesn't affect associated enrollments that are in SUBMITTED, PROVISIONING or LIVE status. If you need to update the provider details for an enrollment with these statuses, contact support.
Authorizationstringrequiredheader

A Stedi API Key for authentication.

Path Parameters

The Stedi-assigned identifier for the provider you want to update.

Body

application/json
namestringrequired

The provider's business name. This is typically the provider's practice name, such as Dental Associates, LLC, but it can also be the provider's first and last name.

  • Minimum length: 5
contactsarray<object>

Either organizationName or firstName and lastName are required.

Array item

The contact's business name.

The contact's first name.

The contact's last name.

contacts[].emailstringrequired

The contact's email address.

  • Pattern: ^\S+@\S+\.\S+$
  • Minimum length: 5
contacts[].phonestringrequired

The contact's phone number, starting with the area code and formatted with dashes as separators. For example, 555-555-5555.

  • Minimum length: 8

The contact's street address, including the street number, name, and any suite or apartment number.

  • Minimum length: 5

The contact's street address continued.

contacts[].citystringrequired

The contact's city.

  • Minimum length: 2
contacts[].zipCodestringrequired

The contact's five-digit ZIP code.

  • Minimum length: 5
contacts[].statestringrequired

The contact's two-letter state abbreviation. For example, PA, or MD.

  • Minimum length: 2

Response

application/json

UpdateProvider 200 response

idstringrequired

A unique identifier Stedi assigns to this provider.

createdAtstring

The date and time Stedi created the provider record.

  • Format: date-time
updatedAtstring

The date and time Stedi last updated the provider record.

  • Format: date-time
npistringrequired

The provider's National Provider Identifier (NPI). This is a 10-digit number that is unique to the provider. Note that each provider record must have a unique NPI within Stedi - you cannot create a provider with an NPI that is already in use.

  • Pattern: ^[0-9]{10}$
taxIdTypestringrequired

The type of tax ID. Can be either an EIN - Employer Identification Number, or an SSN - Social Security Number.

Possible values
EIN
SSN
taxIdstringrequired

The provider's tax ID, as specified by taxIdType. This identifier has to be provided without any separators, such as dashes or spaces. For example 111-22-3333 is invalid but 111223333 is valid.

  • Pattern: ^\d{9}$
namestringrequired

The provider's business name. This is typically the provider's practice name, such as Dental Associates, LLC, but it can also be the provider's first and last name.

  • Minimum length: 5
contactsarray<object>

Either organizationName or firstName and lastName are required.

Array item

The contact's business name.

The contact's first name.

The contact's last name.

contacts[].emailstringrequired

The contact's email address.

  • Pattern: ^\S+@\S+\.\S+$
  • Minimum length: 5
contacts[].phonestringrequired

The contact's phone number, starting with the area code and formatted with dashes as separators. For example, 555-555-5555.

  • Minimum length: 8

The contact's street address, including the street number, name, and any suite or apartment number.

  • Minimum length: 5

The contact's street address continued.

contacts[].citystringrequired

The contact's city.

  • Minimum length: 2
contacts[].zipCodestringrequired

The contact's five-digit ZIP code.

  • Minimum length: 5
contacts[].statestringrequired

The contact's two-letter state abbreviation. For example, PA, or MD.

  • Minimum length: 2