/API reference//
- Get an email batch
Submit a certified email
Query certified emails (GET)
Request an on-demand affidavit
Create an email batch
Query email batches (HTTP QUERY method)
Update an email batch
Delete an email batch
Set the batch body
Add batch recipients (CSV)
Query batch recipients (HTTP QUERY method)
Delete all batch recipients
Add a batch attachment
List batch attachments
Delete all batch attachments
Download a batch attachment
Delete a batch attachment
Get an email batch
Retrieves the full state of a batch, including its configured email template and processing progress.
Sécurité
basicAuth
- https://api.evicertia.comhttps://api.evicertia.com/v2/EviMail/Batches/{BatchId}
- https://api.ecertia.comhttps://api.ecertia.com/v2/EviMail/Batches/{BatchId}
curl -i -X GET \
-u '<username>:<password>' \
'https://api.evicertia.com/v2/EviMail/Batches/{BatchId}'Batch retrieved.
The email template configured for the batch (the per-email settings applied to every recipient).
Réponse
{ "Id": "38a5a5bb-dc30-49a2-b175-1de0d1488c43", "State": "Draft", "Submitter": "string", "SubmitterId": "string", "SiteName": "string", "SiteId": "2ee62ea7-ea8b-4a01-be17-6f02722940c2", "Description": "string", "CreationDate": "2019-08-24T14:15:22Z", "ScheduledFor": "2019-08-24T14:15:22Z", "StartedOn": "2019-08-24T14:15:22Z", "ProcessedOn": "2019-08-24T14:15:22Z", "SubmittedOn": "2019-08-24T14:15:22Z", "InvalidOn": "2019-08-24T14:15:22Z", "LastUpdated": "2019-08-24T14:15:22Z", "TotalCount": 0, "EviMail": { "Subject": "string", "Body": "string", "IssuerName": "string", "CostCentre": "string", "From": "string", "DisableSenderHeader": true, "ReplyTo": "string", "TimeToLive": 0, "CertificationLevel": "Standard", "LtaStorage": true, "AffidavitKinds": [ … ], "Language": "string", "AffidavitLanguage": "string", "OnlineRetentionPeriod": 0, "PushNotificationUrl": "http://example.com", "PushNotificationFilter": [ … ], "PushNotificationExtraData": "string", "CommitmentOptions": "Disabled", "CommitmentCommentsAllowed": true, "RejectReasons": [ … ], "AcceptReasons": [ … ], "RequireRejectReason": true, "RequireAcceptReason": true, "DeliveryAppearance": "Certified", "OwnerNotificationTemplate": "string" }, "BatchPushNotificationUrl": "http://example.com", "SentCount": 0, "FailedCount": 0, "ProgressPercentage": 0.1, "ExtraFields": [ "string" ], "InvalidReason": "string", "CsvId": "5b047477-7a4a-4e84-8bbf-e1f64f3318c7", "Outcome": "string" }