Passer au contenu

Query batch recipients (HTTP QUERY method)

Requête

Lists the recipients of a batch, with cursor pagination.

This endpoint uses the HTTP QUERY method, not GET. OpenAPI cannot express the QUERY method, so it is shown here as a GET with the filter fields as query parameters. In practice, send an HTTP QUERY request with the fields (Cursor, Limit, SortDirection) in a JSON body.

Sécurité
basicAuth
Chemin
BatchIdstring, (uuid)obligatoire
Requête
Cursorstring
Limitinteger, [ 1 .. 1000 ]
SortDirectionstring
Enum:"None""Ascending""Descending"
curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.evicertia.com/v2/EviMail/Batches/{BatchId}/Recipients?Cursor=string&Limit=1&SortDirection=None'

Réponses

Query executed successfully.

Corpsapplication/json
Cursorstring
ResultsArray of objects(EviMailBatchRecipient)
Réponse
{ "Cursor": "string", "Results": [ { … } ] }