Archive API docs
    Jump to

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

    Jump to examples ↓
    Mutation

    addLabelsToCreators

    Assign labels to creators by name, creating any name the workspace does not carry yet. Priced per creator; for large batches use bulkAddLabelsToCreators.

    Arguments

    creatorIds [ID!]! required
    Creator ids to label, as returned by searchCreators or creator. At least 1 and at most 40. If any id does not resolve in this workspace, the WHOLE call is rejected (all-or-nothing) with a userErrors entry naming it under creatorIds; nothing is written.
    labelNames [String!]! required
    Label names to assign. At least 1 and at most 50, each at most 100 characters. Matching ignores case and surrounding whitespace; a name that matches no label creates it.

    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.

    creators [Creator!]!
    The creators as stored after the write. Empty when userErrors is non-empty.
    userErrors [UserError!]!
    Errors that refused the whole request: an empty or oversized list, a call costing more than the workspace's rate-limit capacity, a blank or over-long name, an unknown creator id, a label being deleted, more than one label assignment in the same request, or a workspace with no user to attribute the write to. Empty on success.