# Update an SMS batch

Updates batch metadata and the message template options, including the SMS Text. All fields are optional; only the fields supplied are changed. Setting State transitions the batch (for example, to start processing). Setting ScheduledDate schedules the batch. Batch scheduling uses UTC. Specify ScheduledDate in UTC.

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

## 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)
    Scheduled execution date and time in UTC.

  - `State` (string)
    Enum: "Draft", "Submitted", "Scheduled", "Processing", "Processed", "Invalid", "Failed"

  - `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)
    Enum: "Submitted", "SubmittedAdvanced", "TransmissionResult", "DeliveryResult", "Read", "Closed", "ClosedAdvanced", "Complete", "CompleteAdvanced", "Event"

  - `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)
    Enum: "Ready", "Sent", "Dispatched", "Delivered", "Read", "Closed", "Failed", "AffidavitPublished"

  - `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 fields

## Response 400 fields

## Response 401 fields

## Response 404 fields