Cards

Download the error report CSV for a card import batch

Download a CSV report containing all rows from the specified import batch that were classified as invalid, duplicate, or unauthorized during validation.

GET

/fm/cards/imports/{import_batch_id}/errors

curl --request GET \
  --url https://api.catch-e.com/fm/cards/imports/{import_batch_id}/errors \
  --header 'Authorization: <api-key>'

<string>

The CSV file includes a header row followed by one data row per failed or skipped validation row. Rows classified as create or update are not included in this report.

Returns 404 if the specified batch does not exist.

This method requires the Cards:Get permission to be associated with your role.

CSV columns:

Column	Description
`row_number`	1-based row number from the original upload file (excluding the header row)
`card_number`	Card number from the uploaded row
`action`	Intended action: `create`, `update`, or blank if action could not be determined
`status`	Row classification: `invalid`, `duplicate`, or `unauthorized`
`error_message`	Human-readable description of why the row failed validation

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Path Parameters

import_batch_idstringrequired

The import_batch_id returned from the upload step.

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]*$

Response

CSV file containing all rows that failed or were skipped during validation. Content-Disposition header will be set to attachment; filename="card-import-{import_batch_id}-errors.csv".

bodystring

Still need help? Ask the team