# Update message

Partially updates an existing Message. Only provided fields will be updated.

Endpoint: PATCH /site/{siteId}/ahds/v1/message/{messageId}
Version: 1.0
Security: bearer

## Path parameters:

  - `siteId` (number, required)
    Site identifier

  - `messageId` (string, required)
    Message unique identifier (UUID)

## Request fields (application/json):

  - `body` (string)
    Full content of the message.

  - `channel` (string)
    Primary communication channel used to deliver the message.
    Enum: "internal", "email", "sms", "phone", "push", "portal", "other"

  - `deliveredAt` (string)
    Timestamp when the message was delivered to the recipient's channel, if known.
    Example: "2025-01-01T00:00:00.000Z"

  - `extensions` (object)
    Vendor- or practice-specific extensions.

  - `from` (object)
    Sender of the message, if known.

  - `messageType` (string)
    High-level classification of the message.
    Enum: "system", "user", "integration", "alert", "reminder", "other"

  - `priority` (string)
    Relative importance of the message.
    Enum: "low", "normal", "high", "urgent"

  - `readAt` (string)
    Timestamp when the message was first read, if tracked.
    Example: "2025-01-01T00:00:00.000Z"

  - `relatedEntities` (array)
    References to entities this message is about (e.g., animal, appointment, invoice).

  - `relatedEntities.display` (string)
    Optional display label for the related entity.

  - `relatedEntities.entityId` (string, required)
    Identifier of the related entity.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `relatedEntities.entityType` (string, required)
    Type of the related entity.
    Enum: "animal", "client", "appointment", "invoice", "medicalRecord", "task", "other"

  - `sentAt` (string)
    Timestamp when the message was sent or made available to recipients.
    Example: "2025-01-01T00:00:00.000Z"

  - `status` (string)
    Current lifecycle status of the message.
    Enum: "draft", "queued", "sent", "delivered", "read", "failed", "cancelled", "archived"

  - `subject` (string)
    Short subject or title of the message.

  - `to` (array)
    Primary recipients of the message.

  - `to.contactId` (string)
    External contact recipient of the message.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `to.display` (string)
    Human-readable name of the recipient.

  - `to.userId` (string)
    User recipient of the message.
    Example: "123e4567-e89b-12d3-a456-426614174000"

## Response 200 fields (application/json):

  - `body` (string, required)
    Full content of the message.

  - `channel` (string, required)
    Primary communication channel used to deliver the message.
    Enum: "internal", "email", "sms", "phone", "push", "portal", "other"

  - `createdAt` (string, required)
    Timestamp when the message record was created.
    Example: "2025-01-01T00:00:00.000Z"

  - `deliveredAt` (string, required)
    Timestamp when the message was delivered to the recipient's channel, if known.
    Example: "2025-01-01T00:00:00.000Z"

  - `extensions` (object, required)
    Vendor- or practice-specific extensions.

  - `from` (object, required)
    Sender of the message, if known.

  - `messageId` (string, required)
    Canonical unique identifier for the message.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `messageType` (string, required)
    High-level classification of the message.
    Enum: "system", "user", "integration", "alert", "reminder", "other"

  - `priority` (string, required)
    Relative importance of the message.
    Enum: "low", "normal", "high", "urgent"

  - `readAt` (string, required)
    Timestamp when the message was first read, if tracked.
    Example: "2025-01-01T00:00:00.000Z"

  - `relatedEntities` (array, required)
    References to entities this message is about (e.g., animal, appointment, invoice).

  - `relatedEntities.display` (string)
    Optional display label for the related entity.

  - `relatedEntities.entityId` (string, required)
    Identifier of the related entity.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `relatedEntities.entityType` (string, required)
    Type of the related entity.
    Enum: "animal", "client", "appointment", "invoice", "medicalRecord", "task", "other"

  - `sentAt` (string, required)
    Timestamp when the message was sent or made available to recipients.
    Example: "2025-01-01T00:00:00.000Z"

  - `status` (string, required)
    Current lifecycle status of the message.
    Enum: "draft", "queued", "sent", "delivered", "read", "failed", "cancelled", "archived"

  - `subject` (string, required)
    Short subject or title of the message.

  - `to` (array, required)
    Primary recipients of the message.

  - `to.contactId` (string)
    External contact recipient of the message.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `to.display` (string)
    Human-readable name of the recipient.

  - `to.userId` (string)
    User recipient of the message.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `updatedAt` (string, required)
    Timestamp when the message record was last updated.
    Example: "2025-01-01T00:00:00.000Z"


## Response 400 fields

## Response 401 fields

## Response 404 fields