Skip to content
AdCrunch
Esc
navigateopen⌘Jpreview
On this page

brand_delete

Delete a brand and the context authored on it, guarded by base_revision.

Deletes a Brand and all the context written on it. Guarded by base_revision — the revision you last read via brand_get — so a brand someone just edited can’t be removed out from under them.

Input

Field Type Required Description
brand_name string yes The slug identifying which brand to delete.
base_revision number yes The revision you last read. Guards concurrent edits.

Output

{ deleted: true, slug }.

Example

brand_get({ brand_name: 'acme-running' }); // → revision 4
brand_delete({ brand_name: 'acme-running', base_revision: 4 });
// → { deleted: true, slug: 'acme-running' }

Requires the brand:write scope.

Was this page helpful?