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

    importCreators

    Import creators into the current workspace by social handle; returns an operationId to poll with operation(id:) and operationRecords.

    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.

    creators [CreatorImportInput!]! required
    The creators to import, 1 to 250. More than 250 refuses the whole request.
    operationId ID
    Optional version 4 UUID to mint the operation with, so a retried request cannot start a second import: a repeat with the same id is refused with a userError on operationId and the first operation keeps running. Omit it to get a server-minted id.

    Returns

    acceptedCount Int!
    Number of creators accepted into the import operation.
    operationId ID
    ID of the background import operation. Poll operation(id:) and operationRecords with it. Null when every creator was skipped or the request was refused.
    skipped [ImportCreatorsSkippedRow!]!
    Creators skipped instead of imported, with the reason for each.
    userErrors [UserError!]!
    Errors that refused the whole request: an empty or oversized creators list, a creator with too many handles, more than 20 labels or a label name over 100 characters, an operationId that is not a version 4 UUID or was already used, labels locked by another import (retry the request), or a workspace with no user to attribute the import to. A cap one creator breaks points at it: field is ["creators", "<index>", "handles"] or ["creators", "<index>", "labels"]. Empty on success.