Archive API docs
    Jump to

    Narrow by kind with a prefix — q: queries, m: mutations, t: types, g: guides, f: fields and arguments.

    Mutations

    Write operations exposed by the Archive GraphQL API, grouped by functional area.

    Items & Media

    requestUsageRights
    Request usage rights or an ad code for items through the workspace's UGC Repurpose campaign.
    uploadItemFromUrl
    Queue one UGC URL for import into the current workspace. The import is not an operation (poll itemIdsByUrl), and it may create a creator and social profile for an account the workspace does not track yet.

    Creators & Social Profiles

    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.
    setCreatorCustomAttributes
    Set one custom attribute value on up to 1,000 creators. Up to 40 creators are written in the request; more run as a background operation.

    Labels

    addLabelsToCreators
    Assign labels to creators by name, creating any name the workspace does not carry yet. Priced per creator; for large batches use bulkAddLabelsToCreators.
    bulkAddLabelsToCreators
    Assign labels to up to 1,000 creators in the background; returns an operationId to poll with operation(id:).
    bulkRemoveLabelsFromCreators
    Remove label assignments from up to 1,000 creators in the background; returns an operationId to poll with operation(id:).
    createLabels
    Create labels in the workspace creator label taxonomy; a name already present (ignoring case and surrounding whitespace) is returned unchanged.
    deleteLabel
    Schedule deletion of one label across the whole workspace; deletion is asynchronous and irreversible, and the creators survive.
    mergeLabels
    Fold one label into another across the whole workspace; asynchronous and irreversible — every creator carrying it ends up on the target, and the source label is deleted.
    removeLabelsFromCreators
    Remove label assignments from creators by name; the labels themselves survive. Priced per creator; for large batches use bulkRemoveLabelsFromCreators.
    renameLabel
    Rename one label across the whole workspace; asynchronous — every creator carrying it follows the new spelling.

    Engagement

    refetchEngagementBulk
    Queue an engagement data refresh for the specified items.

    Campaigns

    createCampaign
    Create a campaign of a given campaignType in the current workspace. Idempotent on externalId.
    deleteCampaign
    Hard-delete a campaign of a type the API provisions, exactly as deleting it in the app does. Irreversible.
    updateCampaign
    Change a campaign: rename it, move its end date, add or remove creators on its roster, and, on a CONTENT_CAPTURE or BRAND_MONITORING campaign, add or remove its posts.

    Collections

    addItemToCollections
    Add an item to one or more Collections.
    createCollection
    Create a Collection (a saved tag set) in the current workspace.
    deleteCollection
    Hard-delete a Collection. Its tag is stripped from items; the items themselves stay.
    moveCollectionToGroup
    Move a Collection into a view group, or out of its group when groupId is null.
    removeItemFromCollections
    Remove an item from one or more Collections.
    updateCollection
    Rename a Collection in the current workspace.

    Views & View Groups

    createContentView
    Create a saved Content View for the current workspace.
    createCreatorView
    Create a saved Creator View for the current workspace.
    createSocialProfileView
    Create a saved Social Profile View for the current workspace.
    createViewGroup
    Create a user-created view group for the current workspace.
    deleteContentView
    Hard-delete a saved Content View.
    deleteCreatorView
    Hard-delete a saved Creator View.
    deleteSocialProfileView
    Hard-delete a saved Social Profile View.
    deleteViewGroup
    Hard-delete a user-created view group. Returns the FilterPreset UUIDs of the views that left the group, so clients can invalidate cached views.
    moveContentViewToGroup
    Move a saved Content View into a view group, or out of its group when groupId is null.
    moveCreatorViewToGroup
    Move a saved Creator View into a view group, or out of its group when groupId is null.
    moveSocialProfileViewToGroup
    Move a saved Social Profile View into a view group, or out of its group when groupId is null.
    reorderViewsInGroup
    Reorder the submitted Content View, Social Profile View, and Creator View ids within the named group. Members omitted from viewIds keep their relative order and sort after the listed views.
    updateContentView
    Partial-update a saved Content View.
    updateCreatorView
    Partial-update a saved Creator View.
    updateSocialProfileView
    Partial-update a saved Social Profile View.
    updateViewGroup
    Rename a user-created view group.

    Custom Attributes

    addCustomAttributeOptions
    Add options to a creator select field; names the field already has are skipped.
    createCustomAttributeSchema
    Create a creator custom attribute field of a value or select type. The key is derived from the name.

    Async Operations

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

    Deep Research

    createDeepResearchReport
    Start a Deep Research report in the current workspace; it spends credits.

    Webhooks

    createWebhookSubscription
    Create an outbound-webhook subscription. Returns the signing secret exactly once.
    deleteWebhookSubscription
    Hard-delete a webhook subscription and its deliveries.
    enableWebhookSubscription
    Re-enable a subscription that failures auto-disabled. Optionally replay the last 24h of failed deliveries.
    redeliverWebhookDelivery
    Replay one terminal failed delivery once.
    rotateWebhookSubscriptionSecret
    Rotate a webhook subscription's signing secret. Returns the new secret once.
    sendWebhookTestEvent
    Send a signed synthetic ping to a subscription's endpoint and return the settled delivery.
    updateWebhookSubscription
    Partial-update a webhook subscription.

    Feedback

    submitFeedback
    Report a problem with the Archive API (a bug, unclear docs, a missing capability, an unexpected result) to the Archive team. Not visible to workspace users; no reply.