Update Contact

Update an existing contact

patch

/contacts/{contact_id}

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

application/json

patch/contacts/{contact_id}

PATCH /v2/contacts/{contact_id} HTTP/1.1
Host: api.medicare.healthsherpa.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2451

{
  "contact": {
    "external_id": "CRM123456",
    "first_name": "Alex",
    "last_name": "Lee",
    "address_1": "1215 19th St",
    "address_2": "Suite 100",
    "birth_date": "01/15/1955",
    "city": "Sacramento",
    "state": "CA",
    "zip": "95811",
    "phone": "8557722663",
    "sex": "male",
    "email": "[e-mail]",
    "medicare_number": "1EG4TE5MK73",
    "medicare_part_a_effective_date": "01/01/2024",
    "medicare_part_b_effective_date": "01/01/2024",
    "medicaid_eligible": false,
    "medicaid_number": "MED123456",
    "extra_help": false,
    "type": "client",
    "status": "in_progress",
    "notes": [
      "Initial contact made on 03/20/2024"
    ],
    "authorized_representative_name": "Jane Doe",
    "authorized_representative_relationship": "spouse",
    "authorized_representative_phone_number": "8551234567",
    "authorized_representative_email": "[e-mail]",
    "authorized_representative_address": "456 Oak Ave",
    "authorized_representative_city": "Sacramento",
    "authorized_representative_state": "CA",
    "authorized_representative_zip_code": "95811",
    "mailing_address_street": "789 Mailing Ln",
    "mailing_address_unit_number": "Apt 2B",
    "mailing_address_city": "Sacramento",
    "mailing_address_state": "CA",
    "mailing_address_zip_code": "95811",
    "contact_drugs_attributes": [
      {
        "name": "amoxicillin",
        "drug_type_id": 1,
        "dosage_name": "amoxicillin CAP 250MG",
        "ndc": "54570126563",
        "frequency": 30,
        "user_quantity": 100,
        "id": "drug-1",
        "id_source": "connecture",
        "dosage_id": "dosage-1",
        "dosage_id_source": "connecture",
        "package_id": "package-1",
        "package_id_source": "connecture",
        "package_description": "Bottle",
        "package_size": 10,
        "package_quantity": 1,
        "metric_quantity": 5
      }
    ],
    "contact_pharmacies_attributes": [
      {
        "id": "pharm-1",
        "id_source": "connecture",
        "name": "Neighborhood Pharmacy",
        "mode": "retail",
        "npi": "3878698333",
        "primary": true,
        "phone_number": "[phone]",
        "address_street": "123 Medical Blvd",
        "address_unit_number": "Suite 100",
        "address_city": "Durham",
        "address_state": "NC",
        "address_zip_code": "27707"
      }
    ],
    "contact_providers_attributes": [
      {
        "id": "provider-1",
        "id_source": "connecture",
        "provider_type": "individual",
        "presentation_name": "Dr. Chelsey Schneider, MD",
        "primary": true,
        "first_name": "Chelsey",
        "last_name": "Schneider",
        "organization_name": "Health Group",
        "phone_number": "[phone]",
        "npi": "1234567890",
        "specialties": [
          "Internal Medicine",
          "Cardiology"
        ],
        "contact_provider_addresses_attributes": [
          {
            "id": "addr-123",
            "id_source": "connecture",
            "street": "123 Medical Blvd",
            "unit_number": "Suite 100",
            "city": "Durham",
            "state": "NC",
            "zip_code": "27707",
            "phone_numbers": [
              "919-555-0123",
              "919-555-0124"
            ],
            "selected": true
          }
        ]
      }
    ]
  }
}

{
  "data": {
    "status": "success",
    "errors": [],
    "contact": {
      "id": "c7716192-7625-4351-a689-3df3b65ba0e2",
      "slug": "jane-testbasic",
      "external_id": "TEST-1738780800000-abc123",
      "first_name": "Jane",
      "last_name": "TestBasic",
      "phone": "5129998888",
      "address_1": "999 Updated Street",
      "city": "Dallas",
      "state": "TX",
      "zip": "75201",
      "type": "client"
    },
    "redirect_url": "https://medicare.healthsherpa.com/agents/agent-name/plans/c7716192-7625-4351-a689-3df3b65ba0e2"
  }
}