Partially updates an existing Communication. Only provided fields will be updated.
Identifier of the resource this communication is associated with.
Type of resource this communication is associated with (e.g. Contact, Animal, Consult).
Identifier of the communicating party when different from associatedResourceId.
Type of the communicating party (e.g. Contact, Animal) when different from associatedResourceType.
Identifier of the ContactDetailType used to send the communication.
Destination address/identifier for the communication, format defined by contactDetailTypeId.
Direction of the communication relative to the practice.
Origin address/identifier for the communication, if available.
When the communication was marked as read, if applicable.
Delivery or processing status of the communication.
- Mock serverhttps://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/communication/{communicationId}
- Local Developmenthttp://localhost:8083/site/{siteId}/ahds/v1/communication/{communicationId}
curl -i -X PATCH \
'https://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/communication/{communicationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"associatedResourceId": "123e4567-e89b-12d3-a456-426614174000",
"associatedResourceType": "example",
"communicatingResourceId": "123e4567-e89b-12d3-a456-426614174000",
"communicatingResourceType": "example",
"contactDetailTypeId": "123e4567-e89b-12d3-a456-426614174000",
"content": "example",
"contentFormat": "SMS",
"destination": "123e4567-e89b-12d3-a456-426614174000",
"direction": "OUTGOING",
"extensions": {},
"isActive": true,
"origin": "123e4567-e89b-12d3-a456-426614174000",
"readAt": "2025-01-01T00:00:00.000Z",
"sentAsUser": {},
"status": "PENDING",
"subject": "example",
"template": {}
}'Communication updated successfully
Identifier of the resource this communication is associated with.
Type of resource this communication is associated with (e.g. Contact, Animal, Consult).
Identifier of the communicating party when different from associatedResourceId.
Type of the communicating party (e.g. Contact, Animal) when different from associatedResourceType.
Canonical identifier for the communication.
Identifier of the ContactDetailType used to send the communication.
Format of the communication content.
When the communication record was created.
Destination address/identifier for the communication, format defined by contactDetailTypeId.
Direction of the communication relative to the practice.
Origin address/identifier for the communication, if available.
When the communication was marked as read, if applicable.
Delivery or processing status of the communication.
{ "associatedResourceId": "123e4567-e89b-12d3-a456-426614174000", "associatedResourceType": "example", "communicatingResourceId": "123e4567-e89b-12d3-a456-426614174000", "communicatingResourceType": "example", "communicationId": "123e4567-e89b-12d3-a456-426614174000", "contactDetailTypeId": "123e4567-e89b-12d3-a456-426614174000", "content": "example", "contentFormat": "SMS", "createdAt": "2025-01-01T00:00:00.000Z", "destination": "123e4567-e89b-12d3-a456-426614174000", "direction": "OUTGOING", "extensions": {}, "isActive": true, "origin": "123e4567-e89b-12d3-a456-426614174000", "readAt": "2025-01-01T00:00:00.000Z", "sentAsUser": {}, "status": "PENDING", "subject": "example", "template": {}, "updatedAt": "2025-01-01T00:00:00.000Z" }