POST v2/EviNotice/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:

• Address* : Contains the recipient's email address or mobile phone number (with country code). It is used to send the notification to the recipient

• Legalname: Company name of the recipient.

• Lookupkey: Client identifier. Contains a unique identifier of the customer to facilitate the search in your systems.

• Displayname*: Name of the recipient. Contains the name of the recipient to be displayed in the notifications.

• Evidenceaccesscontrolchallenge: In case of configuring the evinotice with access to custody through "Challenge", this field contains the question to be answered by the recipient in order to access the evidence generated in the process.

• Evidenceaccesscontrolchallengeresponse: If the EviNotice is configured with access to custody through "Challenge", this field contains the response that the recipient must give in order to access the evidence generated in the process.

• Deliverysignchallenge: This column must be accompanied by a value in deliverysignchallengeresponse and sets the EviNotice signature method to "Challenge". It contains the question that the recipient must answer to access the notification message. If this column is informed, the following columns must be empty deliverysignfixedemail, deliverysignfixedmobile. Since only one signature method can be set per recipient.

• Deliverysignchallengeresponse: This column must be accompanied by a value in deliverysignchallenge and sets the EviNotice signature method to "Challenge". It contains the response to be given by the recipient to access the notification message. If this column is informed, the following columns must be empty deliverysignfixedemail, deliverysignfixedmobile. Since only one signature method can be set per recipient.

• Deliverysignfixedemail: Sets the signature method as "PIN to email". The recipient will receive a PIN code to the email address set in this field. If this column is informed, the following columns must be empty deliverysignchallenge, deliverysignchallengeresponse, deliverysignfixedmobile. Since only one signature method can be set per recipient.

• Deliverysignfixedmobile: Set the signature method as "PIN to mobile". The recipient will receive a PIN code to the phone number set in this field. The phone number must contain the country code (e.g. +34666000888). If this column is filled in, the following columns must be empty: deliverysignchallenge, deliverysignchallengeresponse, deliverysignfixedemail. Since only one signature method can be set per recipient.

• 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:

     address|legalname|lookupkey|displayname|evidenceaccesscontrolchallenge|evidenceaccesscontrolchallengeresponse|deliverysignchallenge|deliverysignchallengeresponse|deliverysignfixedemail|deliverysignfixedmobile recipient01@recipientmail.com|recipientlegalname01|001|recipientname01|||||recipient01@narecipientmailmirial.com|| recipient02@recipientmail.com|recipientlegalname02|002|recipientname02|||||recipient02@recipientmail.com|| recipient03@recipientmail.com|recipientlegalname03|003|recipientname03|||||recipient03@recipientmail.com||

     Example Format with additional headers:

     address|legalname|lookupkey|displayname|evidenceaccesscontrolchallenge|evidenceaccesscontrolchallengeresponse|deliverysignchallenge|deliverysignchallengeresponse|deliverysignfixedemail|deliverysignfixedmobile|varcontract|varpostalcode recipient01@recipientmail.com|recipientlegalname01|001|recipientname01|||||recipient01@narecipientmailmirial.com||01|contract01 recipient02@recipientmail.com|recipientlegalname02|002|recipientname02|||||recipient02@recipientmail.com||02|contract02 recipient03@recipientmail.com|recipientlegalname03|003|recipientname03|||||recipient03@recipientmail.com||03|contract03

Output Parameters

• No output parameters.

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

Request Example