Trigger Backup

POST 
/api/v1/accounts/:id/backup

Triggers an on-demand backup for a specific account. The backup runs asynchronously: a successful request queues the job and returns the account with its backup_status set to "pending" — poll GET /accounts/{id} or GET /accounts/{id}/backups for progress and the eventual outcome. Returns 422 if the account is not currently in a backupable state (e.g. paused, lapsed subscription, or a connection that needs to be re-authorized), and 409 if a backup for the account is already in progress. Account IDs follow the format: acc_ followed by 16 alphanumeric characters (e.g., acc_1234567890abcdef).

Request

Responses

200

backup queued

401

unauthorized

404

not found

409

conflict

422

unprocessable entity

429

too many requests

Response Headers

X-RateLimit-Limit

Your request allowance for the current window.

X-RateLimit-Remaining

Requests remaining in the current window.

X-RateLimit-Reset

Unix time (seconds) at which the window resets.

Retry-After

Seconds to wait before retrying.