# Update an SMS batch

Updates supplied batch metadata and message template options, including the SMS `Text`. Blank values for text fields are ignored. To submit a Draft or Invalid batch, set `State` to `Submitted` and send a future `ScheduledDate` in UTC. The stored batch must have text, recipients, a positive TTL, 1–20 years of online retention, and a valid certification level. Batches created through the API have no defaults for `TimeToLive`, `OnlineRetentionPeriod`, or `CertificationLevel`. Set them before submitting or in the same PATCH request. A Submitted or Scheduled batch can be returned to Draft before processing starts.

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

## Security:

  - `basicAuth` (unknown)
    http basic

## Path parameters:

  - `BatchId` (string, required)

## Request fields (application/json):

  - `IssuerName` (string)
    Legal name or short identifier for the sending organisation, recorded in the certification evidence. This is not the sender shown in the recipient's inbox (that sender is configured at the account level).

  - `ScheduledDate` (string)
    Future execution date and time in UTC. Required with State Submitted.

  - `State` (string)
    Enum: "Draft", "Submitted"

  - `Description` (string)

  - `Text` (string)
    The SMS message content for this batch.

  - `TimeToLive` (integer)

  - `CostCentre` (string)

  - `CertificationLevel` (string)
    Supported values include `Standard`, `Advanced`, and their regional variants, such as `Standard_EU` or `Advanced_EU`. Availability depends on the account.
    Enum: "Standard", "Advanced", "Standard_CO", "Standard_CR", "Standard_EC", "Standard_EU", "Standard_MX", "Standard_PE", "Advanced_CO", "Advanced_CR", "Advanced_EC", "Advanced_EU", "Advanced_MX", "Advanced_PE"

  - `AffidavitKinds` (array)
    Batches use SMS. Do not select the RCS-only Read affidavit.

  - `Language` (string)

  - `AffidavitLanguage` (string)

  - `OnlineRetentionPeriod` (integer)

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

  - `PushNotificationUrl` (string)
    Push notification URL propagated to every message generated from the batch — it becomes each message's own callback URL for the normal per-message 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)

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

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

  - `OwnerNotificationTemplate` (string)

## Response 200:

  - `200` (unknown)
    Batch updated.

## Response 400:

  - `400` (unknown)
    Invalid request.

## Response 401:

  - `401` (unknown)
    Authentication failed

## Response 403:

  - `403` (unknown)
    The site does not use by-submission billing.

## Response 404:

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

