# Update a notice batch

Updates batch metadata and the notice template options. All fields are optional; only the fields supplied are changed. Setting `State` transitions the batch (for example, to start processing or schedule it). Setting `ScheduledDate` schedules the batch for later dispatch. Batch scheduling uses UTC. Specify `ScheduledDate` in UTC.

Endpoint: PATCH /v2/EviNotice/Batches/{BatchId}
Version: 1.0
Security: basicAuth

## Security:

  - `basicAuth` (unknown)
    http basic

## Path parameters:

  - `BatchId` (string, required)
    The UUID of the batch, as returned at creation.

## Request fields (application/json):

  - `IssuerName` (string)

  - `Subject` (string)
    Subject line of the notice. (The body is set with the Body endpoint.)

  - `ScheduledDate` (string)
    Scheduled execution date and time in UTC.

  - `State` (string)
    Transitions the batch to a new state (for example, `Submitted` to start processing).
    Enum: "Draft", "Submitted", "Scheduled", "Processing", "Processed", "Invalid", "Failed"

  - `Description` (string)

  - `From` (string)

  - `DisableSenderHeader` (boolean)

  - `ReplyTo` (string)

  - `TimeToLive` (integer)
    Delivery/accessibility window in minutes.

  - `CostCentre` (string)

  - `CertificationLevel` (string)
    Certification level applied to every notice in the batch.
    Enum: "None", "Standard", "Advanced", "QERDS", "Standard_CO", "Standard_CR", "Standard_EC", "Standard_EU", "Standard_MX", "Standard_PE", "Advanced_CO", "Advanced_CR", "Advanced_EC", "Advanced_EU", "Advanced_MX", "Advanced_PE", "QERDS_ES", "QERDS_IT"

  - `AffidavitKinds` (array)

  - `Language` (string)
    BCP 47 language tag for the hosted notice UI.

  - `AffidavitLanguage` (string)
    BCP 47 language tag for generated affidavits.

  - `OnlineRetentionPeriod` (integer)

  - `LtaStorage` (boolean)
    Enables post-close LTA storage for every notice generated from the batch. Each notice is stored after its own tracking reaches `Closed`. Requires LTA to be enabled for the site.

  - `PushNotificationUrl` (string)
    Push notification URL propagated to every notice generated from the batch — it becomes each notice's own callback URL for the normal per-notice lifecycle callbacks. Alias of `BatchPushNotificationUrl` (both set the same value; if both are supplied, this one is applied last). The batch itself has no separate lifecycle callback — track batch progress with `GET .../{BatchId}`.

  - `PushNotificationFilter` (array)

  - `PushNotificationExtraData` (string)

  - `CommitmentOptions` (string)
    Enum: "Disabled", "Accept", "Reject", "AcceptOrReject"

  - `CommitmentCommentsAllowed` (boolean)

  - `RejectReasons` (array)

  - `AcceptReasons` (array)

  - `RequireRejectReason` (boolean)

  - `RequireAcceptReason` (boolean)

  - `DeliveryAppearance` (string)
    Enum: "Certified", "AsIs"

  - `BatchPushNotificationUrl` (string)
    Alias of `PushNotificationUrl` — both set the same value. It is propagated to every notice generated from the batch as that notice's own callback URL; the batch has no separate lifecycle callback. Track batch progress with `GET .../{BatchId}`.

  - `AllowRefusal` (boolean)

  - `OwnerNotificationTemplate` (string)

  - `Channel` (string)
    Notification channel for the batch.

## Response 200:

  - `200` (unknown)
    Batch updated.

## Response 400:

  - `400` (unknown)
    Invalid request.

## Response 401:

  - `401` (unknown)
    Authentication failed

## Response 404:

  - `404` (unknown)
    No batch with the given BatchId was found.

