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

    clearCreatorCustomAttribute

    Remove one custom attribute value from up to 1,000 creators. Up to 40 creators are written in the request; more run as a background operation.

    Arguments

    creatorIds [ID!]! required
    Creator ids, as returned by searchCreators or creator. At least 1 and at most 1000. If any id does not resolve in this workspace, the whole call is refused with one userErrors entry per unknown id under creatorIds; nothing is written.
    key String! required
    The creator custom attribute key, as listed by customAttributeSchemas(entity: CREATOR). The labels key and read-only keys are refused.

    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.

    acceptedCount Int!
    Number of distinct creators the call covers. 0 when userErrors is non-empty.
    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 the write runs as a background operation. False when it was written in the request or userErrors is non-empty.
    updatedCount Int!
    Number of creators written in the request. 0 when the write was scheduled or refused.
    userErrors [UserError!]!
    Errors that refused the whole request: an empty or oversized list, an unknown creator id, an unknown or read-only key, a value the key does not accept, too many bulk operations in flight, or a workspace with no user to attribute the write to. Empty on success.