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

    bulkAddLabelsToCreators

    Assign labels to up to 1,000 listed creators, or every creator a filter matches, in the background; returns an operationId to poll with operation(id:).

    Arguments

    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.

    creatorIds [ID!]
    Creator ids to label, as returned by searchCreators or creator. At least 1 and at most 1000. An id that does not resolve in this workspace is skipped and returned in skippedCreatorIds; the rest are scheduled. Omit it to label by filter / customAttributeConditions instead.
    customAttributeConditions [CustomAttributeConditionInput!]
    Act on every creator matching these custom-attribute conditions (AND), as creators(customAttributeConditions:) would list them. Combine with filter; omit creatorIds.
    filter CreatorFilterInput
    Act on every creator this filter matches, as creators(filter:) would list them. Combine with customAttributeConditions; omit creatorIds. The request checks for a match before scheduling. A filter matching most of a huge workspace can time out; narrow it and call once per part.
    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

    acceptedCount Int!
    Number of distinct creators scheduled. For a filter, the number of creators it matched when the operation was scheduled; the operation acts on the creators matching when it starts.
    operationId ID
    The background operation; poll it with operation(id:) and its per-creator outcomes with operationRecords. Null when scheduled is false.
    scheduled Boolean!
    True when an operation was scheduled. False when userErrors is non-empty, when no creator id resolved in this workspace, or when the filter matched no creator.
    skippedCreatorIds [ID!]!
    Submitted creator ids that do not resolve in this workspace and were not scheduled.
    userErrors [UserError!]!
    Errors that refused the whole request: an empty or oversized id list, a blank or over-long name, a label being deleted, too many label bulk operations already in flight, or a workspace with no user to attribute the operation to. Empty on success.