Updates an existing contact in the HealthSherpa system. The contact must be owned by the authenticated agent. Only fields that are included in the request will be updated. When updating nested resources (drugs, pharmacies, providers), the existing nested records are replaced with the new ones. external_id cannot be changed once it has a value; submitting a different external_id returns a 422.
Required scopes
This endpoint requires the following scopes:
: Access to Partner API v2 endpoints
Authorizations
OAuth2authorizationCodeRequired
OAuth 2.0 authentication with partner_api_v2 scope
Authorization URL: Token URL:
Path parameters
contact_idstringRequired
The HealthSherpa system ID of the contact to update
Body
Responses
200
Contact updated successfully. May return partial_success status if any of the sub-records (drugs, pharmacies, providers) failed to save.
application/json
400
Validation error
application/json
401
Unauthorized - Invalid, missing, or expired OAuth access token. 401 responses for token problems are produced by the OAuth layer and follow the OAuth 2.0 Bearer Token error format ({"error": "...", "error_description": "..."}) rather than the standard {error: {code, message}} envelope used by the rest of the API.
application/json
403
The access token does not have the required partner_api_v2 scope. Like other OAuth errors, this response uses the OAuth 2.0 Bearer Token error format.
application/json
404
Agent not found for the authenticated user
application/json
422
The request was well-formed but could not be processed
