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.

    Jump to examples ↓
    Mutation

    requestUsageRights

    Request usage rights or an ad code for items through the workspace's UGC Repurpose campaign.

    MCP: requestUsageRights

    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.

    itemIds [ID!]! required
    Item ids to request, 1 to 100. Only Instagram and TikTok items can be requested; any other id is listed in skippedItemIds.
    message String
    The message to the creator, 5 to 1000 characters. Defaults to the workspace default message for the request type and platform.
    requestType UsageRightsRequestType! required
    What to ask the creator for.

    Returns

    requestedItemIds [ID!]!
    Items requested by this call. Each now has a usage-rights request with status IN_QUEUE.
    skippedItemIds [ID!]!
    Items not requested, as passed in itemIds. These are ids outside this workspace, items not from Instagram or TikTok, and items that already have a request. Items past the campaign item or creator limit are skipped too.
    userErrors [UserError!]!
    Errors that refused the whole call. Causes: an empty or oversized itemIds list, or a message of the wrong length. Also no message while the workspace default is blank. Also a workspace with no user to attribute the write to. Nothing is requested when this is non-empty.