Update Project

patch

https://management.sandbox.particlehealth.com/v1/{project.name}

Updates mutable fields such as display_name, npi, address, and lifecycle state.

Path Params

project.name

string

required

The resource name of the Project. Should match the pattern projects/{project_id}.

Body Params

display_name

string

A user defined name for the Project.

state

string

enum

State represents represents if a Project or Connection is Active or Inactive on the data exchange networks.

STATE_ACTIVE: Represents a Project/Connection that is registered on the data exchange networks.
STATE_INACTIVE: Represents a Project that is either not registered, or not active on the data exchange networks.
STATE_ACTIVE_PENDING: Represents a Project that is pending registration on the data exchange networks.

Allowed:

npi

string

National Provider Index for the Project.

address

object

Address for the Project.

commonwell_type

string

enum

CommonwellType is a network required ENUM and should be chosen as the value that closest resembles the treatment relation this entity has with its patients.

Allowed:

is_obo

boolean

True if the Project is an OBO entity on at least one of the networks.

npi_type

string

Responses

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

400Returned when the request is malformed or missing required fields.

401Returned when the caller does not have permission to access the resource.

404Returned when the resource does not exist.

429Returned when the caller has exceeded the rate limit.

500Server error