Read the head of an uploaded file to pick its email column before creating a bulk verification. Free: no credits. Answers the headers, up to 5 preview rows, the delimiter, the encoding, whether the first row is a header, and the columns that hold email addresses (best first). Nothing is stored.

How are credits spent?

Free. Nothing is stored.

When to use it

Call it on an uploaded file before Create Email Verification to see the file's headers, up to 5 preview rows, its delimiter and encoding, whether the first row is a header, and which columns hold email addresses (best first in email_column_candidates, with suggested_email_column).

data.file_key must be a file uploaded to your own workspace: a key uploaded by another workspace answers 403. Uploading a file through the API is not public yet, so today the key comes from a file uploaded in the app. To verify a list from the API, send the addresses in data.emails to Create Email Verification.

Body parameters

• dataobjectrequired

  The uploaded file to read.

  Field	Type	Description
  file_key	stringrequired	The key of a file uploaded to your workspace (an App upload today: API uploads are not public yet). max length: 512.

Responses

• 200 The head of the file.
• 400 Invalid body (VALIDATION_ERROR with payload.code), or the file could not be read (VALIDATION_ERROR, no code).
• 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
• 403 The file belongs to another workspace (FORBIDDEN).
• 500 Unexpected server error.

For error handling see Errors.