Update Contact
Updates an existing contact in the HealthSherpa system. The contact must be owned by the agent specified in the request. Only fields that are included in the request will be updated.
Authorizations
Path parameters
contact_idstringRequired
The HealthSherpa system ID of the contact to update
Body
agent_emailstring · emailRequired
Email of the agent who owns this contact
Responses
200
Contact updated successfully
application/json
204
No changes were made to the contact
application/json
400
Validation error
application/json
401
Unauthorized - Invalid API key
application/json
404
Not Found
application/json
422
The request was well-formed but could not be processed
application/json
patch
PATCH /v1/contacts/{contact_id} HTTP/1.1
Host: api.medicare.healthsherpa.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 558
{
"agent_email": "[email protected]",
"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",
"email": "[email protected]",
"extra_help": false,
"medicaid_eligible": false,
"medicaid_number": "MED123456",
"medicare_number": "123456789A",
"medicare_part_a_effective_date": "01/01/2024",
"medicare_part_b_effective_date": "01/01/2024",
"notes": [
"Initial contact made on 03/20/2024"
],
"phone": "8557722663",
"sex": "male",
"state": "CA",
"type": "client",
"zip": "95811"
}
}{
"data": {
"contact": {
"id": "c7716192-7625-4351-a689-3df3b65ba0e2",
"slug": "some-slug",
"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",
"email": "[email protected]",
"extra_help": false,
"medicaid_eligible": false,
"medicaid_number": "MED123456",
"medicare_number": "123456789A",
"medicare_part_a_effective_date": "01/01/2024",
"medicare_part_b_effective_date": "01/01/2024",
"phone": "8557722663",
"sex": "male",
"state": "CA",
"type": "client",
"zip": "95811"
},
"redirect_url": "https://medicare.healthsherpa.com/agents/alex-lee/plans/c7716192-7625-4351-a689-3df3b65ba0e2?search=%7B%3Azip%3D%3E%2298134%22%7D"
}
}Last updated