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
searchCreatorsorcreator. At least 1 and at most 1000. An id that does not resolve in this workspace is skipped and returned inskippedCreatorIds; the rest are scheduled. Omit it to label byfilter/customAttributeConditionsinstead. - customAttributeConditions [CustomAttributeConditionInput!]
- Act on every creator matching these custom-attribute conditions (AND), as
creators(customAttributeConditions:)would list them. Combine withfilter; omitcreatorIds. - field String! required
- Key of the custom attribute to filter on, as returned by customAttributeSchemas (e.g. "sentiment").
- operator FilterOperator! required
- Comparison operator. The valid set depends on the attribute type; see FilterOperator.
- BETWEEN
- Inclusive range match for number and date types; value is { from, to }.
- CONTAINS
- For text-like types: substring match. For multi-select and list types: matches records containing ANY of the provided values (OR semantics).
- CONTAINS_ALL
- For multi-select custom attributes: matches records whose value array contains ALL of the provided values (AND semantics).
- DOES_NOT_CONTAIN
- For text-like types: excludes substring matches. For multi-select and list types: excludes records containing any of the provided values.
- ENDS_WITH
- Suffix match, for text-like types.
- EQUAL
- Equality, for number and date types.
- IS
- Exact match. For text and single-select types (for selects, value is the option ID) and BOOLEAN (value is true/false).
- IS_EMPTY
- Matches records with no value set. Value is ignored; pass null.
- IS_NOT
- Exact non-match, for text and single-select types.
- IS_NOT_EMPTY
- Matches records with any value set. Value is ignored; pass null.
- IS_RELATIVE_TO_TODAY
- Matches date values in a period relative to today; value is { relation: "past"|"this"|"next", period: "day"|"week"|"month"|"year" } (offset optional: a whole number of periods, at most 100 years; tz optional: an IANA time zone).
- LESS_THAN
- Strictly less than, for number and date types.
- LESS_THAN_OR_EQUAL
- Less than or equal, for number and date types.
- MORE_THAN
- Strictly greater than, for number and date types.
- MORE_THAN_OR_EQUAL
- Greater than or equal, for number and date types.
- NOT_EQUAL
- Inequality, for number and date types.
- STARTS_WITH
- Prefix match, for text-like types.
- type CustomAttributeType! required
- Type of the custom attribute, as returned by customAttributeSchemas. Determines the expected value shape and the valid operators.
- BOOLEAN
- True/false value.
- BOOLEAN_LIST
- List of true/false values.
- DATE
- Calendar date value (ISO 8601, no time component).
- DATETIME
- Date-and-time value (ISO 8601).
- DATETIME_LIST
- List of date-and-time values (ISO 8601).
- DATE_LIST
- List of calendar date values (ISO 8601, no time component).
- Email address value.
- MULTIPLE_SELECT
- Multiple choices from a predefined option list; the stored value is an array of option IDs.
- MULTIPLE_SELECT_V2
- Multiple choices from a predefined option list; the stored value is an array of option IDs. Successor revision of MULTIPLE_SELECT with identical filtering behavior.
- NUMBER
- Numeric value.
- NUMBER_LIST
- List of numeric values.
- PHONE
- Phone number value.
- SHIPPING_ADDRESS
- Structured shipping address. Not filterable: conditions with this type are rejected with a validation error; read the value from the record's customAttributes instead.
- SINGLE_SELECT_V2
- Single choice from a predefined option list; the stored value is an option ID.
- SINGLE_SELECT_V3
- Single choice from a predefined option list; the stored value is an option ID. Successor revision of SINGLE_SELECT_V2 with identical filtering behavior.
- TEXT
- Free-form text value.
- TEXT_LIST
- List of free-form text values.
- URL
- URL value.
- value JSON
- Comparison value; the shape depends on type: a string for text-like types, an option ID for single-selects, a number for NUMBER, an ISO 8601 string for dates, true/false for BOOLEAN, an array for multi-select and list types. BETWEEN takes { from, to }. Pass null for IS_EMPTY / IS_NOT_EMPTY.
- filter CreatorFilterInput
- Act on every creator this filter matches, as
creators(filter:)would list them. Combine withcustomAttributeConditions; omitcreatorIds. 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. - accountNames [String!] default []
- Filter to creators with a linked social profile whose handle matches any of the given values. A bare handle (e.g. "janedoe") matches on every platform; prefix it with the provider (
instagram:,tiktok:oryoutube:, e.g. "tiktok:janedoe") to match that platform only. Matching ignores case; multiple handles OR together; an empty or omitted list leaves the result set unconstrained. - campaignsIds [ID!] default []
- Filter to creators on the roster of any of the given campaign IDs (the IDs returned by
campaigns). Multiple IDs OR together; an empty or omitted list leaves the result set unconstrained. IDs from another workspace match nothing. - locations [LocationCanonicalInput!]
- Filter creators by canonical location. Each entry ANDs its populated components (country/region/city); multiple entries OR together, which is useful for disambiguating same-named cities (e.g. Portland, Oregon vs. Portland, Maine). Canonical values come from the Geo normalization pipeline; omit a component to leave it unconstrained. An entry may instead name a region group (
group, a code fromlocationGroups), which matches creators in any of its member countries. - city String
- Canonical city name (e.g. "Portland"). Matches creator.city_canonical exactly.
- country String
- Canonical country name (e.g. "United States"). Matches creator.country_canonical exactly.
- group String
- Region group code from
locationGroups(e.g. "european_union", "dach"). The entry matches every member country of the group and country/region/city are ignored in it; an unknown code matches nothing. - region String
- Canonical region/state name (e.g. "Oregon"). Matches creator.region_canonical exactly.
- 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 withoperationRecords. Null whenscheduledis 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.
- field [String!]
- Path to the input field that caused the error.
- message String!
- The error message.