Archive API docs
esc
    Jump to
    Getting started Token, first query, response Explorer Run queries in the browser items The connection most integrations start with Changelog Additions and deprecations

    Narrow by kind with a prefix — q: queries, m: mutations, t: types, g: guides, f: fields and arguments.

    Jump to examples ↓
    Mutation

    deleteLabel

    Schedule deletion of one label across the whole workspace; deletion is asynchronous and irreversible, and the creators survive.

    MCP: deleteLabel

    Arguments

    labelName String! required
    The label to delete, exactly as the labels query returns it. A name is the label identity — labels have no id in this API — and matching ignores case and surrounding whitespace, so any spelling of the same label deletes it. Deletion is workspace-wide and irreversible: the label leaves the taxonomy AND every creator carrying it. A blank name is rejected. Not length-limited: a label longer than the creation limit stays deletable.

    Returns

    Object, input and enum types open in place — use + to reveal their fields. A type that is already open above the row stops at a ↻ circular marker, and anything nested past the depth limit links out to its own page instead.

    labelName String!
    The label name you submitted, echoed back verbatim — never the workspace's stored spelling.
    operationId ID
    The delete_label operation that owns this label's deletion; poll it with operation(id:). Null when userErrors is non-empty. A label operation tracks progress with status, total and processed only — its record-derived counts are always 0 and its item-id lists always empty.
    scheduled Boolean!
    True when the deletion is scheduled — including when this label's deletion was already in flight, in which case operationId is that deletion's operation. False when userErrors is non-empty. Deletion is asynchronous.
    userErrors [UserError!]!
    Errors that refused the request: a blank name, a name matching no label in this workspace, or a workspace with no user to attribute the deletion to. Empty on success.