bulk

Create a new bulk search by uploading an Excel or CSV file.

post/v5.1/bulk/multipart

Request

  • Base URL: https://api.anymailfinder.com
  • URL: https://api.anymailfinder.com/v5.1/bulk/multipart
  • Auth: API key in header Authorization

Headers

x-webhook-urlstring

If provided, the result will be POSTed to this URL instead of waiting for the response.

Response

Created.

status'on_deck' | 'queued' | 'running' | 'paused' | 'completed' | 'deleted' | 'extraction_queued' | 'extraction_running' required

The current status of the bulk operation. Each status represents a specific stage in the bulk operation lifecycle:<br /> - "on_deck": Indicates the bulk file has been uploaded through the UI, but the columns have not been mapped yet. This status is internal and typically not encountered by API users.<br /> - "queued": The bulk operation is queued and will be processed soon. This status implies that the operation is in the waiting list and will be picked up by the processing system.<br /> - "running": The bulk operation is currently in progress. This status indicates that the processing of the bulk file is actively ongoing.<br /> - "paused": The operation has been temporarily paused.<br /> - "completed": The bulk operation has been completed successfully. All records in the bulk file have been processed as intended.<br /> - "failed": The bulk operation has failed. This status indicates that there was an error during the processing which prevented the operation from completing successfully.<br /> Note: The status flow typically progresses from "queued" to "running", and then to either "completed" or "failed", but can also include "paused".

created_atstring date-time required
credits_needednumber required
decision_maker_categorystring nullable required
file_namestring required
idstring required
paidboolean required
started_running_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.