Delete a file format

Overview

Remove a column mapping and its sample file.

Use this to retire an automation.

You'll need the mapping id.

The mapping is removed; automatic sending for it stops.

Prerequisites

• A bearer token. See Authentication.
• The file format's id (fileHeaderId).

Base URL

Endpoint

DELETE /api/v1/campaign/automate/file-headers/{fileHeaderId}

Authentication

Account token

• The file format's campaign must be an automation campaign in your own account; otherwise 403.

Rate limit

This endpoint has no rate limit.

Request parameters

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Response payload

{
  "data": {
    "status": "success",
    "message": "File headers deleted successfully"
  }
}

Examples

Success payload

See Response payload.

Error payload

403 Not your file format

{
  "message": "Not authorized to delete this file header configuration",
  "status": "error",
  "errors": []
}

404 Already deleted

{
  "message": "File header configuration not found",
  "status": "error",
  "errors": []
}

422 Unknown file format

{
  "message": "The selected id is invalid.",
  "errors": {
    "id": [
      "The selected id is invalid."
    ]
  }
}

Example request

curl --request DELETE \
  --url "https://production-api.shoutaboutus.com/api/v1/campaign/automate/file-headers/4" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'