Delete account

DELETE /api/v2/accounts/{customerId} Hard-deletes an account under your organization. Only CHILD-type accounts can be deleted, and the caller must be an ADMIN on the organization (or an Apostra SuperAdmin). The request is refused if the account still has linked resources. For normal account deletion, send no request body and remove dependent resources first. Deleting an account does not lower the organization’s count toward the 25 accounts it can create in any 24 hours: the limit counts creations, so the account still counts for 24 hours after it was created. See Accounts in an organization.

Request

curl

curl -X DELETE https://api.apostra.com/api/v2/accounts/205 \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

Parameters

Field	In	Type	Required	Notes
`customerId`	path	string	Yes	ID of the account to delete

Staging canary cleanup proof

runOwnedCleanupReceipt is reserved for the automated Apostra publisher-onboarding staging canary. It is not a general cascade-delete option, and customer integrations must omit it.

After the internal preparation endpoint has persisted an exact cleanup receipt, the canary reconciler attaches that receipt when finalizing its disposable test seller:

{
  "runOwnedCleanupReceipt": {
    "kind": "publisher_onboarding_canary",
    "receiptToken": "550e8400-e29b-41d4-a716-446655440000",
    "campaignIds": ["campaign_01JEXAMPLE"]
  }
}

Field	Type	Required	Notes
`runOwnedCleanupReceipt.kind`	string	Yes when the receipt is supplied	Must be `publisher_onboarding_canary`. Any other value is rejected with `400`.
`runOwnedCleanupReceipt.receiptToken`	string	Yes when the receipt is supplied	UUID returned by the internal cleanup-preparation request.
`runOwnedCleanupReceipt.campaignIds`	string[]	Yes when the receipt is supplied	Up to 20 unique campaign IDs bound to the durable receipt.

The service accepts this receipt only for a marked disposable publisher-onboarding test child, from an Apostra SuperAdmin acceptance-test request scoped to its exact parent. It rechecks the persisted account, campaign, strategy, and advertiser proof before deletion. Missing cleanup steps, new dependencies, or any receipt mismatch fail closed.

Response

204 No Content — the account was deleted. The response body is empty.

Errors

400 VALIDATION_ERROR — the account is not a deletable child, or the optional canary receipt is malformed.
401 UNAUTHORIZED — missing or invalid bearer token.
403 FORBIDDEN — caller is not an ADMIN on the target account’s parent organization (including when an existing account is outside the caller’s organization), or receipt-bound cleanup was requested without the required internal authority.
404 NOT_FOUND — the account does not exist.
409 CONFLICT — the account still has linked resources, or the receipt no longer exactly matches the target child and its cleanup state.

See Errors for the full error contract.

Account tasks

All account operations

List accounts

Accounts you can access

Start here

Buy media

Sell media

Help and updates

Request

Parameters

Staging canary cleanup proof

Response

Errors

Account tasks

List accounts

​Request

​Parameters

​Staging canary cleanup proof

​Response

​Errors

​Related

Account tasks

List accounts

Request

Parameters

Staging canary cleanup proof

Response

Errors

Related