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.
- handles [CreatorImportHandleInput!]! required
- The creator's handles, 1 to 5. A creator with more than 5 refuses the whole request.
- handle String! required
- The creator's handle on that platform, with or without a leading '@', or their profile URL on it.
- provider CreatorImportProvider! required
- Platform the handle belongs to.
- A handle or profile URL on INSTAGRAM.
- TIKTOK
- A handle or profile URL on TIKTOK.
- YOUTUBE
- A handle or profile URL on YOUTUBE.
- labels [String!] default []
- Names of the labels to apply to the creator, up to 20 distinct names of up to 100 characters each; more refuses the whole request. Names are trimmed, and null, blank and repeated names are ignored, so they do not count toward the cap; a repeat must match exactly, so names differing only in case count separately. Length is counted in Unicode code points, so an emoji built from several code points counts as several characters. A label missing from the workspace is created.
- 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
operationIdand 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:)andoperationRecordswith it. Null when every creator was skipped or the request was refused. - skipped [ImportCreatorsSkippedRow!]!
- Creators skipped instead of imported, with the reason for each.
- handle String
- The handle that caused the skip, as it was sent. Null when the creator had no handles.
- index Int!
- Zero-based position of the creator in the
creatorsargument. - provider CreatorImportProvider
- Platform of the handle that caused the skip. Null when the creator had no handles.
- A handle or profile URL on INSTAGRAM.
- TIKTOK
- A handle or profile URL on TIKTOK.
- YOUTUBE
- A handle or profile URL on YOUTUBE.
- reason CreatorImportSkipReason!
- Why the creator was skipped.
- INVALID_HANDLE
- A handle is not a valid handle or profile URL on its platform.
- NO_HANDLES
- The creator had no handles left to import.
- UNKNOWN_PROVIDER
- A handle named a platform creator import does not support.
- userErrors [UserError!]!
- Errors that refused the whole request: an empty or oversized
creatorslist, a creator with too many handles, more than 20 labels or a label name over 100 characters, anoperationIdthat 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:fieldis ["creators", "<index>", "handles"] or ["creators", "<index>", "labels"]. Empty on success. - field [String!]
- Path to the input field that caused the error.
- message String!
- The error message.