Archive brand
archive_brandHides a brand from list_brands — for a brand the user is done with, or an accidental duplicate. Doesn't delete anything underneath it (campaigns, connections, billing history all stay intact). Not reversible from here — the user restores it from the Rebbel dashboard. An archived brand publishes, schedules and promotes nothing; pass cancelScheduled: true to also cancel its scheduled posts now (they stay approved, without a time).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| brandId | Yes | The brand's id, from list_brands. Only archive one the user actually wants gone from their list — this hides it (campaigns, connections, and billing history are all kept intact), it isn't a hard delete, but there's no unarchive tool here — the user restores it from the dashboard if they change their mind. | |
| cancelScheduled | No | Pass true to also cancel every post of this brand that is scheduled and not yet published, on every channel — each goes back to approved with no time, and nothing is re-scheduled if the brand is restored later. Published posts are never touched. Either way, an archived brand publishes nothing: a scheduled post that comes due while it is archived is cancelled instead of published. |