Versions Compared

Version Old Version 3 New Version Current
Changes made by

Jose Luis Lozano

Jose Luis Lozano

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejson
PATCH /v2/EviSMS/Batches
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{
    "Description": "Bulk invitation mailing",
    "IssuerName": "Marketing Team",    
    "Text": "This is the content of the SMS"
    "CostCentre": "Marketing",
    "AffidavitKinds": ["Delivery"],
    "Language": "en",
    "AffidavitLanguage": "en",
    "OnlineRetentionPeriod": 1,
    "LtaStorage": false,
    "PushNotificationUrl": "https://client.callback.url/notifications",
    "PushNotificationFilter": ["Delivered", "Submitted"],
    "PushNotificationExtraData": "Spring Campaign",    
    "HideBanners": true,
    "BatchPushNotificationUrl": "https://client.callback.url/batch-notifications"   
}
Code Block
json

{ "BatchId": "a5b1f3f2-5c73-4b6d-88b9-73d81a9c5f8e" }

Request Examples to finalize a Batch

...

  1. Batch ID Requirement:

    • The batchid in the URL must correspond to an existing batch created via the initial Submit endpoint.

  2. The system automatically checks if the user has enough credits for the SMS and adjusts the credit based on the messages finally processed.

  3. Timezone:

    • Ensure the ScheduledDate datetime is in a standard format (e.g., ISO 8601) and considers timezone differences.