https://api.brale.xyz/accounts/{account_id}/automations/{automation_id}
Required scope: automations:write
Path parameters
Request body
Request
Responses
200 OK
Returns the fullAutomation object with status: "archived".
Response
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Archives an automation, permanently stopping it from processing deposits. The underlying virtual account is closed and billing is released.
https://api.brale.xyz/accounts/{account_id}/automations/{automation_id}
Required scope: automations:write
| Parameter | Type | Required | Description |
|---|---|---|---|
account_id | string (KSUID) | Yes | The account that owns the automation. |
automation_id | string (KSUID) | Yes | The automation to archive. |
| Field | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Must be "archived". |
{
"status": "archived"
}
Automation object with status: "archived".
{
"id": "3D8pEQwvYY7cJXmQkojpZZ9vdr3",
"name": "ACE Corp 5",
"status": "archived",
"source": {
"transfer_type": null,
"value_type": "USD",
"funding_instructions": {
"account_number": "488255579773",
"beneficiary_name": "Brand Account 2",
"bank_address": "8700 Perry Highway Pittsburgh, PA 15237",
"beneficiary_address": "7834 pipe drive San Diego, CA 92115",
"routing_number": "043087080",
"bank_name": "SSB Bank"
}
},
"destination": {
"address_id": "3D8odPs57kcf4kErbi8snLOQg0H",
"transfer_type": "base",
"value_type": "ACE"
},
"updated_at": "2026-06-04T21:13:53.122105Z",
"created_at": "2026-05-01T22:10:38.297457Z",
"brand": {
"account_id": "3D8occi363tmBYDByo0Rr292kBO"
}
}
Was this page helpful?