Update a contact
curl --request PATCH \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/crm/contacts/{contact_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "<string>",
"owner_staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referral_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interest": "<string>",
"desired_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"desired_provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"estimated_value_cents": 123,
"tags": [
"<string>"
],
"custom_fields": {},
"marketing_opt_in": true,
"sms_opt_in": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
email: '<string>',
phone: '<string>',
company: '<string>',
pipeline_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
stage_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source: '<string>',
owner_staff_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
referral_source_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
interest: '<string>',
desired_service_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
desired_provider_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
estimated_value_cents: 123,
tags: ['<string>'],
custom_fields: {},
marketing_opt_in: true,
sms_opt_in: true
})
};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/crm/contacts/{contact_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.clinikehr.com/v1/clinics/{clinic_id}/crm/contacts/{contact_id}"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "<string>",
"owner_staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referral_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interest": "<string>",
"desired_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"desired_provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"estimated_value_cents": 123,
"tags": ["<string>"],
"custom_fields": {},
"marketing_opt_in": True,
"sms_opt_in": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record_type": "lead",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"lifecycle_stage": "lead",
"pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"source": "<string>",
"referral_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referred_by_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interest": "<string>",
"desired_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"desired_provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"estimated_value_cents": 123,
"currency": "<string>",
"priority": "low",
"score": 123,
"marketing_opt_in": true,
"sms_opt_in": true,
"consent_at": "2023-11-07T05:31:56Z",
"consent_source": "<string>",
"do_not_contact": true,
"unsubscribed_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"custom_fields": {},
"converted_patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"converted_at": "2023-11-07T05:31:56Z",
"lost_reason": "<string>",
"last_activity_at": "2023-11-07T05:31:56Z",
"next_task_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}CRM
Update a contact
Permission: crm.contacts:write
Update a CRM contact. Absent fields are unchanged; JSON null clears a nullable field.
status/score/do_not_contact/unsubscribed_at/converted_patient_id/ converted_at/lost_reason are never writable here.
PATCH
/
v1
/
clinics
/
{clinic_id}
/
crm
/
contacts
/
{contact_id}
Update a contact
curl --request PATCH \
--url https://api.clinikehr.com/v1/clinics/{clinic_id}/crm/contacts/{contact_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "<string>",
"owner_staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referral_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interest": "<string>",
"desired_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"desired_provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"estimated_value_cents": 123,
"tags": [
"<string>"
],
"custom_fields": {},
"marketing_opt_in": true,
"sms_opt_in": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
last_name: '<string>',
email: '<string>',
phone: '<string>',
company: '<string>',
pipeline_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
stage_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source: '<string>',
owner_staff_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
referral_source_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
interest: '<string>',
desired_service_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
desired_provider_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
estimated_value_cents: 123,
tags: ['<string>'],
custom_fields: {},
marketing_opt_in: true,
sms_opt_in: true
})
};
fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/crm/contacts/{contact_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.clinikehr.com/v1/clinics/{clinic_id}/crm/contacts/{contact_id}"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "<string>",
"owner_staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referral_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interest": "<string>",
"desired_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"desired_provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"estimated_value_cents": 123,
"tags": ["<string>"],
"custom_fields": {},
"marketing_opt_in": True,
"sms_opt_in": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner_staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"record_type": "lead",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"lifecycle_stage": "lead",
"pipeline_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"source": "<string>",
"referral_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referred_by_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"interest": "<string>",
"desired_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"desired_provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"estimated_value_cents": 123,
"currency": "<string>",
"priority": "low",
"score": 123,
"marketing_opt_in": true,
"sms_opt_in": true,
"consent_at": "2023-11-07T05:31:56Z",
"consent_source": "<string>",
"do_not_contact": true,
"unsubscribed_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"custom_fields": {},
"converted_patient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"converted_at": "2023-11-07T05:31:56Z",
"lost_reason": "<string>",
"last_activity_at": "2023-11-07T05:31:56Z",
"next_task_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"request_id": "<string>",
"detail": "<string>",
"errors": [
{
"pointer": "<string>",
"message": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Absent fields are unchanged. Every property is optional; only present keys are patched.
Available options:
lead, prospect, waitlist, referral, contact Available options:
lead, inquiry, prospect, waitlist, customer, lost Available options:
low, normal, high Response
OK.
Withheld, by NAME: clinic_id (implicit in the path), unsubscribe_token, migrated_from_patient_id, custom_color, created_by, confirmed_opt_in_at, marketing_authorization_id.
Show child attributes
Show child attributes