Delete file headers

Overview

Delete a file-header configuration and its associated sample file from S3. The {fileHeaderId} path parameter is the file-header ID and must be an existing file-header configuration. Emits an audit event (CAMPAIGN_FILE_HEADERS_DELETED).

Prerequisites

• A bearer token in the Authorization header.
• The fileHeaderId of the record you are targeting.

Base URL

Endpoint

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

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Account bearer. The owning campaign must belong to the caller's person.company_id and be of type automation, else 403.

Rate limit

• No rate limit.

Path parameters

How it works

• 200 with a success message in the data object.
• 403 if the caller does not own the configuration's campaign or the campaign is not an automation campaign.
• 422 if {fileHeaderId} does not exist.

Response

200 OK · 200

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

403 Not authorized · 403

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

422 Validation error · 422

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

Errors

Example request

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