Partially updates an existing Contact. Only provided fields will be updated.
Security
bearer
List of contact details such as phone numbers and email addresses.
Issuing authority or jurisdiction for the driver license.
Example:"https://example.com"
Identifier for the owning organization or business unit.
Example:"123e4567-e89b-12d3-a456-426614174000"
- Mock serverhttps://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact/{contactId}
- Local Developmenthttp://localhost:8083/site/{siteId}/ahds/v1/contact/{contactId}
curl -i -X PATCH \
'https://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/contact/{contactId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"businessName": "Example Name",
"code": "CODE-001",
"contactDetails": [
{
"contactDetailId": "123e4567-e89b-12d3-a456-426614174000",
"contactDetailType": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
},
"contactId": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2025-01-01T00:00:00.000Z",
"extensions": {},
"isActive": true,
"isPreferred": true,
"name": "Example Name",
"subscriptionGroups": [
"string"
],
"updatedAt": "2025-01-01T00:00:00.000Z",
"value": "user@example.com",
"valueCleaned": "example"
}
],
"creditStatus": "OK",
"birthDate": "2025-01-01",
"driverLicenseExpiryDate": "2025-01-01",
"driverLicenseIssuer": "https://example.com",
"driverLicenseNumber": "example",
"extensions": {},
"firstName": "Example Name",
"isBusiness": true,
"isCustomer": true,
"isStaffMember": true,
"isSupplier": true,
"isSyndicate": true,
"isVet": true,
"lastName": "Example Name",
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"physicalAddress": "example",
"postalAddress": "example",
"creditStatusConcept": {
"code": "12345",
"system": "http://example.com/codesystem",
"display": "Example Display Name"
}
}'Contact updated successfully
Registered or trading name if the contact is a business.
Example:"Example Name"
List of contact details such as phone numbers and email addresses.
Canonical unique identifier for the contact.
Example:"123e4567-e89b-12d3-a456-426614174000"
Timestamp when the contact was created.
Example:"2025-01-01T00:00:00.000Z"
Date of birth of the contact, if applicable.
Example:"2025-01-01T00:00:00Z"
Expiry date of the driver license.
Example:"2025-01-01T00:00:00Z"
Issuing authority or jurisdiction for the driver license.
Example:"https://example.com"
Identifier for the owning organization or business unit.
Example:"123e4567-e89b-12d3-a456-426614174000"
Timestamp when the contact was last updated.
Example:"2025-01-01T00:00:00.000Z"
Response
{ "businessName": "Example Name", "code": "CODE-001", "contactDetails": [ { … } ], "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "creditStatus": "OK", "birthDate": "2025-01-01T00:00:00Z", "driverLicenseExpiryDate": "2025-01-01T00:00:00Z", "driverLicenseIssuer": "https://example.com", "driverLicenseNumber": "example", "extensions": {}, "firstName": "Example Name", "isBusiness": true, "isCustomer": true, "isStaffMember": true, "isSupplier": true, "isSyndicate": true, "isVet": true, "lastName": "Example Name", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "physicalAddress": "example", "postalAddress": "example", "updatedAt": "2025-01-01T00:00:00.000Z", "creditStatusConcept": { "code": "12345", "system": "http://example.com/codesystem", "display": "Example Display Name" } }