Fail a Staged Snapshot
curl --request POST \
--url https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail \
--header 'Authorization: Bearer <token>'import requests
url = "https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyCampaigns API
Fail a Staged Snapshot
Abandon a staged upload before finalization
POST
/
external-api
/
v1
/
campaigns
/
{apiReference}
/
snapshots
/
{snapshotReference}
/
fail
Fail a Staged Snapshot
curl --request POST \
--url https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail \
--header 'Authorization: Bearer <token>'import requests
url = "https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://getbill.io/external-api/v1/campaigns/{apiReference}/snapshots/{snapshotReference}/fail")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyMarks an
Send an empty body or
Retrying fail against this client-aborted state returns the same
uploading staged snapshot as failed. No debt is changed and missing-debt reconciliation is not run.
Authentication
Requiresdebts:write. Uses the write limiter: 500 requests/hour per company.
string
required
Your campaign reference.
string
required
The staged snapshot reference to abandon.
{}. No fields are accepted.
curl -X POST "https://getbill.io/external-api/v1/campaigns/client-a-2026/snapshots/export-2026-07-17-550e8400/fail" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'
200
{
"error": false,
"message": "Snapshot upload aborted",
"data": {
"api_reference": "client-a-2026",
"snapshot_reference": "export-2026-07-17-550e8400",
"delivery_mode": "staged",
"status": "failed",
"core_applied": false,
"expected_row_count": 2500,
"received_row_count": 1000,
"received_chunk_count": 1,
"next_chunk_index": 1,
"counts": null,
"failure": { "reason": "client_aborted_upload" },
"created_at": "2026-07-17T09:00:00Z",
"updated_at": "2026-07-17T09:02:00Z",
"status_url": "/external-api/v1/campaigns/client-a-2026/snapshots/export-2026-07-17-550e8400"
}
}
200 response. A pending, processing, completed, differently failed, or processing_error snapshot returns 409 snapshot_not_uploading and cannot be cancelled through the API.
Use a new snapshot_reference for corrected data.