# Replace inventory message

Fully replaces an existing Inventory Message. All fields must be provided.

Endpoint: PUT /site/{siteId}/ahds/v1/inventory-message/{messageId}
Version: 1.0
Security: bearer

## Path parameters:

  - `siteId` (number, required)
    Site identifier

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

## Request fields (application/json):

  - `author` (object, required)
    Author of the message (user or system).

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

  - `channel` (string, required)
    Primary communication channel or medium for this message.
    Enum: "internal", "email", "sms", "phone", "push", "other"

  - `clientProvidedId` (string, required)
    Optional client-supplied identifier for idempotency or cross-system correlation.
    Example: "123e4567-e89b-12d3-a456-426614174000"

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

  - `isPinned` (boolean, required)
    Whether this message is pinned or highlighted in the UI.

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

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

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

  - `recipients.display` (string)
    Human-readable display name for the recipient.

  - `recipients.role` (string)
    Recipient role or group, if addressed to a role rather than a specific user.

  - `recipients.userId` (string)
    Recipient user identifier, if applicable.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `relatedInventoryItemId` (string, required)
    Inventory item this message is primarily about, if applicable.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `relatedPurchaseOrderId` (string, required)
    Purchase order this message is related to, if applicable.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `relatedSupplierId` (string, required)
    Supplier this message is related to, if applicable.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `sentAt` (string, required)
    Timestamp when the message was sent, if applicable.
    Example: "2025-01-01T00:00:00.000Z"

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

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

  - `tags` (array, required)
    Free-form tags or labels for filtering and search.

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

## Response 200 fields (application/json):

  - `author` (object, required)
    Author of the message (user or system).

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

  - `channel` (string, required)
    Primary communication channel or medium for this message.
    Enum: "internal", "email", "sms", "phone", "push", "other"

  - `clientProvidedId` (string, required)
    Optional client-supplied identifier for idempotency or cross-system correlation.
    Example: "123e4567-e89b-12d3-a456-426614174000"

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

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

  - `isPinned` (boolean, required)
    Whether this message is pinned or highlighted in the UI.

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

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

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

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

  - `recipients.display` (string)
    Human-readable display name for the recipient.

  - `recipients.role` (string)
    Recipient role or group, if addressed to a role rather than a specific user.

  - `recipients.userId` (string)
    Recipient user identifier, if applicable.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `relatedInventoryItemId` (string, required)
    Inventory item this message is primarily about, if applicable.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `relatedPurchaseOrderId` (string, required)
    Purchase order this message is related to, if applicable.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `relatedSupplierId` (string, required)
    Supplier this message is related to, if applicable.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `sentAt` (string, required)
    Timestamp when the message was sent, if applicable.
    Example: "2025-01-01T00:00:00.000Z"

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

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

  - `tags` (array, required)
    Free-form tags or labels for filtering and search.

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

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


## Response 400 fields

## Response 401 fields

## Response 404 fields