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

    renameLabel

    Rename one label across the whole workspace; asynchronous — every creator carrying it follows the new spelling.

    MCP: renameLabel

    Arguments

    labelName String! required
    The label to rename, exactly as the labels query returns it. Matching ignores case and surrounding whitespace. Not length-limited: a label longer than the creation limit stays renameable. A blank name is rejected.
    newLabelName String! required
    The new spelling, stored as typed (surrounding whitespace is stripped). At most 100 characters. A different label that already has this name refuses the rename — there is no implicit merge; use mergeLabels to fold one label into another. A respelling of the same label (VIP → vip) is allowed. A blank name is rejected.

    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.

    operationId ID
    The rename_label operation that runs this rename; 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 rename is scheduled; operationId is then set. False when userErrors is non-empty. The rename is asynchronous.
    userErrors [UserError!]!
    Errors that refused the request, on the input at fault: a blank or over-long name, a label that does not exist, is being deleted or is already being renamed, a new name that another label already has, or no user to attribute the rename to. Empty on success.