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

    UpdateCampaignInput

    Input for the updateCampaign mutation. Omitted fields are left unchanged. The campaign-level changes (name, dateEnd, settings) apply together or not at all. They apply before the roster changes, which apply before the posts changes. If a campaign-level change is refused, nothing in the call applies.

    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.

    creators CampaignCreatorsPatchInput
    Creators to add to or remove from the campaign's roster.
    dateEnd DateTime
    New end of the campaign's window (UTC), not before its dateStart. For CREATOR_MONITORING, moving it later also extends tracking for creators already on the roster. For VETTING_WORKFLOW, it may not be more than 24 hours from now. Refused on an open-ended BRAND_MONITORING campaign (one without a dateEnd). Uses the supplied instant at whole-second precision; choose your timezone and day boundaries, then convert to UTC before sending it. Must be between 2000-01-01T00:00:00Z and 2100-01-01T00:00:00Z.
    id ID! required
    UUID of the campaign to update. It must be of a type the API provisions (campaignType not null).
    name String
    New campaign name, under the same rules as CreateCampaignInput.name: a blank or invalid name is a userError on input.name. Omit it, or send the current name back unchanged, to keep the name as stored.
    posts CampaignPostsPatchInput
    Posts to add to or remove from a CONTENT_CAPTURE or BRAND_MONITORING campaign; refused on CREATOR_MONITORING.
    settings CampaignSettingsPatchInput
    Changes to the type-specific options. Only the fields you send change; the rest keep their stored values. Changed rules trigger asynchronous re-evaluation of existing in-window posts; already captured posts are not removed.