POST v2/EviMail/Batches/{batchid}/Recipients

HTTP Method: POST

Description:

This endpoint is used to add recipients for a specific bulk email batch. The batchid parameter in the URL is the identifier returned by the Submit endpoint. Recipients are added to the existing list, and there is a limit of 500 recipients per request. For more recipients, multiple calls can be made.

Headers

The following headers can be included in the CSV string as column names:

• EmailAddress(*): Email address of the recipient.

• LegalName(*): Legal name of the recipient.

• LookupKey(*): Unique identifier for the recipient (e.g., a customer ID).

• EvidenceAccessControlChallenge(*): Challenge question for secure evidence access (optional).

• EvidenceAccessControlChallengeResponse(*): Response to the challenge question (optional).

• Additional Headers: User-defined variables that can be used to compose personalized notifications.

(* ) Cabecera obligatoria

Input Parameters

1. Recipients (string)

   • A CSV-like string containing the recipients' details.

   • The first line specifies the headers (e.g., column names).

   • Each subsequent line contains a recipient’s data, separated by commas, with one recipient per line.

   • Example Format without additional headers:

     emailaddress|legalname|lookupkey|EvidenceAccessControlChallenge|EvidenceAccessControlChallengeResponse dest1@recipientmail.com|Recipient 01|00001|Public| dest2@recipientmail.com|Recipient 02|00002|Challengue| dest3@recipientmail.com|Recipient 03|00003|Public| dest4@recipientmail.com|Recipient 04|00004|Challengue|

     Example Format with additional headers:

     emailaddress|legalname|lookupkey|EvidenceAccessControlChallenge|EvidenceAccessControlChallengeResponse|varamount|varcontract dest1@recipientmail.com|Recipient 01|00001|Public||12|Contract1 dest2@recipientmail.com|Recipient 02|00002|Challengue|response1|40|Contract2 dest3@recipientmail.com|Recipient 03|00003|Public||30|Contract3 dest4@recipientmail.com|Recipient 04|00004|Challengue|response2|11|Contract4

Output Parameters

• No output parameters.

  • The endpoint returns an HTTP status code to indicate the result of the operation.

Request Example