# EviNotice

Certified hosted notices with hosted content, attachments, affidavits, and batch delivery via v2.

## Submit a new EviNotice

 - [POST /v2/EviNotice/Submit](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticesubmit.md)

## Get a single EviNotice

 - [GET /v2/EviNotice/{Id}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeget.md)

## Query multiple EviNotices

 - [POST /v2/EviNotice/Query](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticequery.md)

## Download all attachments of an EviNotice

 - [GET /v2/EviNotice/{Id}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeattachmentsdownload.md)

## Download all affidavits of an EviNotice

 - [GET /v2/EviNotice/{Id}/Affidavits](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitsdownload.md)

## Download one EviNotice affidavit

 - [GET /v2/EviNotice/Affidavits/{Id}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitdownload.md)

## Request an on-demand affidavit

 - [POST /v2/EviNotice/Affidavits/Request](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticeaffidavitrequest.md): Generates a custom affidavit for a previously submitted EviNotice. The original submit request must have included AffidavitKinds with the OnDemand value. The notice must still be eligible — not Draft, not Closed, and within the configured per-notice on-demand limit.

## Create a notice batch

 - [POST /v2/EviNotice/Batches](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchcreate.md): Creates a new, empty notice batch. Only a Description is required at creation; the body, recipients, attachments, and options are set with the subsequent batch endpoints. Returns the BatchId used by all other batch operations.

## Query notice batches (HTTP QUERY method)

 - [GET /v2/EviNotice/Batches](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchesquery.md): Lists notice batches owned by the caller (or the caller's site), 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 in a JSON body (States, Cursor, Limit, SortBy, SortOrder, Direction, TextSearch).

## Get a notice batch

 - [GET /v2/EviNotice/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchget.md): Retrieves the full state of a batch, including its configured notice template and processing progress.

## Update a notice batch

 - [PATCH /v2/EviNotice/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchpatch.md): Updates batch metadata and the notice template options. All fields are optional; only the fields supplied are changed. Setting State transitions the batch (for example, to start processing or schedule it). Setting ScheduledDate schedules the batch for later dispatch. Batch scheduling uses UTC. Specify ScheduledDate in UTC.

## Delete a notice batch

 - [DELETE /v2/EviNotice/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchdelete.md): Removes a previously created batch.

## Set the batch body

 - [PUT /v2/EviNotice/Batches/{BatchId}/Body](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchbodyput.md): Sets the HTML body of the notice for this batch. The body is sent as the raw request payload (HTML), not as a JSON field. Use PATCH .../{BatchId} to set the Subject.

## Add batch recipients (CSV)

 - [POST /v2/EviNotice/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchrecipientspost.md): Adds recipients to the batch by uploading a text/csv file. The CSV uses ; as the column separator. Mandatory columns: address, legalname. Optional columns: lookupkey, displayname, custodychallenge, custodychallengeresponse, deliverychallenge, deliverychallengeresponse, deliveryotpchannel, deliveryotpaddress. Custom per-recipient fields are added as extra columns prefixed with  (for example, orderid).

## Query batch recipients (HTTP QUERY method)

 - [GET /v2/EviNotice/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchrecipientsquery.md): 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.

## Delete all batch recipients

 - [DELETE /v2/EviNotice/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchrecipientsdelete.md): Removes all recipients from the batch.

## Add a batch attachment

 - [POST /v2/EviNotice/Batches/{BatchId}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentspost.md): Adds a single attachment to the batch by uploading it as multipart/form-data. The attachment is included in every notice generated from the batch.

## List batch attachments

 - [GET /v2/EviNotice/Batches/{BatchId}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentsget.md): Returns metadata for all attachments configured on the batch.

## Delete all batch attachments

 - [DELETE /v2/EviNotice/Batches/{BatchId}/Attachments](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentsdelete.md): Removes all attachments from the batch.

## Download a batch attachment

 - [GET /v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentget.md): Downloads the binary content of a single batch attachment.

## Delete a batch attachment

 - [DELETE /v2/EviNotice/Batches/{BatchId}/Attachments/{AttachmentId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evinotice/evinoticebatchattachmentdelete.md): Removes a single attachment from the batch.

