# Update separation

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

Endpoint: PATCH /site/{siteId}/ahds/v1/separation/{separationId}
Version: 1.0
Security: bearer

## Security:

  - `bearer` (unknown)
    http bearer JWT

## Path parameters:

  - `siteId` (number, required)
    Site identifier

  - `separationId` (string, required)
    Separation unique identifier (UUID)

## Request fields (application/json):

  - `category` (string)
    High-level category of separation.
    Enum: "ownership", "location", "grouping", "other"

  - `childEntityId` (string)
    Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).
    Example: 123e4567-e89b-12d3-a456-426614174000

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

  - `contactId` (string)
    Reference to the associated contact, if applicable.
    Example: 123e4567-e89b-12d3-a456-426614174000

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

  - `isActive` (boolean)
    Whether this separation record is currently active.
    Example: true

  - `name` (string)
    Human-readable name or label for the separation.
    Example: Example Name

  - `parentEntityId` (string)
    Identifier of the parent entity in the separation relationship (e.g., owner, source group).
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `separationType` (object)
    Specific type of separation as a coded concept.

  - `separationType.code` (string, required)
    Code value
    Example: 12345

  - `separationType.system` (string, required)
    Code system URI
    Example: http://example.com/codesystem

  - `separationType.display` (string)
    Human-readable display
    Example: Example Display Name

## Response 200:

  - `200` (unknown)
    Separation updated successfully

## Response 200 fields (application/json):

  - `category` (string, required)
    High-level category of separation.
    Enum: "ownership", "location", "grouping", "other"

  - `childEntityId` (string, required)
    Identifier of the child entity in the separation relationship (e.g., separated animal, destination group).
    Example: 123e4567-e89b-12d3-a456-426614174000

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

  - `contactId` (string, required)
    Reference to the associated contact, if applicable.
    Example: 123e4567-e89b-12d3-a456-426614174000

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

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

  - `isActive` (boolean, required)
    Whether this separation record is currently active.
    Example: true

  - `name` (string, required)
    Human-readable name or label for the separation.
    Example: Example Name

  - `parentEntityId` (string, required)
    Identifier of the parent entity in the separation relationship (e.g., owner, source group).
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `separationId` (string, required)
    Canonical identifier for this separation relationship.
    Example: 123e4567-e89b-12d3-a456-426614174000

  - `separationType` (object, required)
    Specific type of separation as a coded concept.

  - `separationType.code` (string, required)
    Code value
    Example: 12345

  - `separationType.system` (string, required)
    Code system URI
    Example: http://example.com/codesystem

  - `separationType.display` (string)
    Human-readable display
    Example: Example Display Name

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

## Response 400:

  - `400` (unknown)
    Invalid request body

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 404:

  - `404` (unknown)
    Separation not found

