Archive API docs
esc
    Jump to
    Getting started Token, first query, response Explorer Run queries in the browser items The connection most integrations start with Changelog Additions and deprecations

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

    Input object

    CampaignCreatorsPatchInput

    Changes to a campaign's roster. At most 200 entries per call, add, addCreatorIds and remove together. Entries are independent: an invalid one is reported at its own path (e.g. ["input","creators","add","3","handle"]) and the rest still apply. The same profile in add and remove is refused in both.

    Fields

    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.

    add [CampaignCreatorInput!] default []
    Creators to add. Asynchronous: each is queued for import and joins the roster once resolved (for CREATOR_MONITORING, Archive then pulls their posts back to dateStart and tracks new ones until dateEnd; on BRAND_MONITORING, capture is replayed for an added creator, so their in-window posts from brand-listening sources can be captured, including ones taken out earlier with posts.remove). On VETTING_WORKFLOW, Archive pulls and reviews their posts in the window. One already on the roster is a no-op.
    addCreatorIds [ID!] default []
    Creators already in the workspace to add, by creator id (from creators or creator). Synchronous: each joins the roster during the call, after any removals. A refused id is reported at its own path, e.g. ["input","creators","addCreatorIds","2"]. Refused: an unknown id, an id from another workspace, a full roster, a creator the campaign type does not admit. One already on the roster is a no-op.
    remove [CampaignCreatorInput!] default []
    Creators to take off the roster, now. Their captured posts stay in the campaign; on a CONTENT_CAPTURE or BRAND_MONITORING campaign, take them out with posts.remove. A creator is on the roster once, so any one of their profiles removes them. Also cancels an add of the same profile still waiting to import. One not on the roster is a no-op.