Passer au contenu

Update an SMS batch

Requête

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.

Sécurité
basicAuth
Chemin
BatchIdstring, (uuid)obligatoire
Corpsapplication/jsonobligatoire
IssuerNamestring

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).

ScheduledDatestring, (date-time)

Future execution date and time in UTC. Required with State Submitted.

Statestring
Enum:"Draft""Submitted"
Descriptionstring, <= 255 characters
Textstring

The SMS message content for this batch.

TimeToLiveinteger
CostCentrestring
CertificationLevelstring

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"
AffidavitKindsArray of strings(EviSmsBatchAffidavitKindValue)

Batches use SMS. Do not select the RCS-only Read affidavit.

Items Enum:"Submitted""SubmittedAdvanced""TransmissionResult""DeliveryResult""Read""Closed""ClosedAdvanced""Complete""CompleteAdvanced""Event"
Languagestring
AffidavitLanguagestring
OnlineRetentionPeriodinteger
LtaStorageboolean

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.

PushNotificationUrlstring, (uri)

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}.

PushNotificationFilterArray of strings(EviSmsBatchPushNotificationValue)
Items Enum:"Ready""Sent""Dispatched""Delivered""Read""Closed""Failed""AffidavitPublished"
PushNotificationExtraDatastring
DeliveryAppearancestring
Enum:"Certified""AsIs"
BatchPushNotificationUrlstring, (uri)

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}.

OwnerNotificationTemplatestring
curl -i -X PATCH \
  -u '<username>:<password>' \
  'https://api.evicertia.com/v2/EviSms/Batches/{BatchId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "Text": "We inform you that your request has been processed.",
    "IssuerName": "SendCo",
    "CertificationLevel": "Advanced_EU",
    "TimeToLive": 1440,
    "OnlineRetentionPeriod": 5,
    "Language": "es",
    "State": "Submitted",
    "ScheduledDate": "2030-01-15T10:30:00Z"
  }'

Réponses

Batch updated.