Mutation

createSocialProfileView

Create a saved Social Profile view for the current workspace.

MCP: createSocialProfileView

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.

input CreateSocialProfileViewInput! required: Mutation input.
customAttributeConditions [CustomAttributeConditionInput!] default []: Custom-attribute conditions to narrow the filter set.
field String! required: Key of the custom attribute to filter on, as returned by customAttributeSchemas (e.g. "sentiment").
operator FilterOperator! required: Comparison operator. The valid set depends on the attribute type; see FilterOperator.
BETWEEN: Inclusive range match for number and date types; value is { from, to }.
CONTAINS: For text-like types: substring match. For multi-select and list types: matches records containing ANY of the provided values (OR semantics).
CONTAINS_ALL: For multi-select custom attributes: matches records whose value array contains ALL of the provided values (AND semantics).
DOES_NOT_CONTAIN: For text-like types: excludes substring matches. For multi-select and list types: excludes records containing any of the provided values.
ENDS_WITH: Suffix match, for text-like types.
EQUAL: Equality, for number and date types.
IS: Exact match. For text and single-select types (for selects, value is the option ID) and BOOLEAN (value is true/false).
IS_EMPTY: Matches records with no value set. Value is ignored; pass null.
IS_NOT: Exact non-match, for text and single-select types.
IS_NOT_EMPTY: Matches records with any value set. Value is ignored; pass null.
IS_RELATIVE_TO_TODAY: Matches date values in a period relative to today; value is { relation: "past"|"this"|"next", period: "day"|"week"|"month"|"year" } (offset optional).
LESS_THAN: Strictly less than, for number and date types.
LESS_THAN_OR_EQUAL: Less than or equal, for number and date types.
MORE_THAN: Strictly greater than, for number and date types.
MORE_THAN_OR_EQUAL: Greater than or equal, for number and date types.
NOT_EQUAL: Inequality, for number and date types.
STARTS_WITH: Prefix match, for text-like types.
type CustomAttributeType! required: Type of the custom attribute, as returned by customAttributeSchemas. Determines the expected value shape and the valid operators.
BOOLEAN: True/false value.
BOOLEAN_LIST: List of true/false values.
DATE: Calendar date value (ISO 8601, no time component).
DATETIME: Date-and-time value (ISO 8601).
DATETIME_LIST: List of date-and-time values (ISO 8601).
DATE_LIST: List of calendar date values (ISO 8601, no time component).
EMAIL: Email address value.
MULTIPLE_SELECT: Multiple choices from a predefined option list; the stored value is an array of option IDs.
MULTIPLE_SELECT_V2: Multiple choices from a predefined option list; the stored value is an array of option IDs. Successor revision of MULTIPLE_SELECT with identical filtering behavior.
NUMBER: Numeric value.
NUMBER_LIST: List of numeric values.
PHONE: Phone number value.
SHIPPING_ADDRESS: Structured shipping address. Not filterable: conditions with this type are rejected with a validation error; read the value from the record's customAttributes instead.
SINGLE_SELECT_V2: Single choice from a predefined option list; the stored value is an option ID.
SINGLE_SELECT_V3: Single choice from a predefined option list; the stored value is an option ID. Successor revision of SINGLE_SELECT_V2 with identical filtering behavior.
TEXT: Free-form text value.
TEXT_LIST: List of free-form text values.
URL: URL value.
value JSON: Comparison value; the shape depends on type: a string for text-like types, an option ID for single-selects, a number for NUMBER, an ISO 8601 string for dates, true/false for BOOLEAN, an array for multi-select and list types. BETWEEN takes { from, to }. Pass null for IS_EMPTY / IS_NOT_EMPTY.
filters JSON! required: Opaque filter blob, stored and echoed back but not applied when reading the view: socialProfiles(presetId:) narrows only by this view's customAttributeConditions and sort. Use customAttributeConditions to actually narrow which social profiles the view returns. Pass {} unless cloning an existing view verbatim.
name String! required: Display name for the new social profile view.
showReportingStats Boolean default true: Whether reporting stats should be surfaced. Defaults to true.
sort JSON default []: Sort directives applied when listing social profiles via this view. Defaults to [].

Returns

socialProfileView SocialProfileView: The newly created social profile view. Null on validation failure.
createdAt DateTimeWithZone!: When the view was created.
customAttributeConditions JSON!: Custom-attribute conditions narrowing the filter set.
filters JSON!: Opaque filter blob, stored and echoed back but not applied when reading the view: socialProfiles(presetId:) narrows only by this view's customAttributeConditions and sort. Use customAttributeConditions to filter which social profiles the view returns.
group ViewGroup: Group this view belongs to, or null when the view is ungrouped. Populated by moveSocialProfileViewToGroup.
collections [Collection!]!: Collections that belong to this group, ordered by their position within the group.
createdAt DateTimeWithZone!: When the Collection was created.
group ViewGroup ↻ circular view ViewGroup →: Group this Collection belongs to, or null when ungrouped. Populated by moveCollectionToGroup. Always null for workspaces whose Collections use the older storage.
id ID!: Unique identifier of the Collection in this workspace. Pass it to addItemToCollections / removeItemFromCollections and to collection(id:).
itemCount Int!: Number of items in this workspace tagged with the Collection.
name String!: Display name of the Collection.
updatedAt DateTimeWithZone!: When the Collection was last updated.
contentViews [ContentView!]!: Content Views that belong to this group, ordered by their position within the group.
createdAt DateTimeWithZone!: When the view was created.
customAttributeConditions JSON!: Custom-attribute conditions narrowing the filter set.
filters JSON!: Opaque filter blob defining which items belong to the view.
group ViewGroup ↻ circular view ViewGroup →: Group this view belongs to, or null when the view is ungrouped. Populated by moveContentViewToGroup.
id ID!: Unique identifier (FilterPreset UUID). Use this with items(presetId:).
name String!: Display name of the view.
showReportingStats Boolean!: Whether reporting stats are surfaced in the UI for this view.
sort JSON!: Sort directives applied when listing items via this view.
updatedAt DateTimeWithZone!: When the view was last updated.
createdAt DateTimeWithZone!: When the group was created.
creatorViews [CreatorView!]!: Creator Views that belong to this group, ordered by their position within the group.
createdAt DateTimeWithZone!: When the view was created.
customAttributeConditions JSON!: Custom-attribute conditions narrowing the filter set.
filters JSON!: Opaque filter blob, stored and echoed back but not applied when reading the view: creators(presetId:) narrows only by this view's customAttributeConditions and sort. Use customAttributeConditions to filter which creators the view returns.
group ViewGroup ↻ circular view ViewGroup →: Group this view belongs to, or null when the view is ungrouped. Populated by moveCreatorViewToGroup.
id ID!: Unique identifier of this saved view. Use the returned id with creators(presetId:) to fetch the view's creators.
name String!: Display name of the view.
showReportingStats Boolean!: Whether reporting stats are surfaced in the UI for this view.
sort JSON!: Sort directives applied when listing creators via this view.
updatedAt DateTimeWithZone!: When the view was last updated.
id ID!: Unique identifier.
name String!: Display name of the group.
socialProfileViews [SocialProfileView!]! ↻ circular view SocialProfileView →: Social Profile Views that belong to this group, ordered by their position within the group.
updatedAt DateTimeWithZone!: When the group was last updated.
id ID!: Unique identifier of this saved view. Use the returned id with socialProfiles(presetId:) to fetch the view's social profiles.
name String!: Display name of the view.
showReportingStats Boolean!: Whether reporting stats are surfaced in the UI for this view.
sort JSON!: Sort directives applied when listing social profiles via this view.
updatedAt DateTimeWithZone!: When the view was last updated.
userErrors [UserError!]!: List of user-facing validation errors. Empty on success.
field [String!]: Path to the input field that caused the error.
message String!: The error message.

Open in explorer ↗

Values are sampled from a demo workspace — substitute your own token and workspace id.

Create a saved Social Profile view for the workspace.

query.graphql

mutation CreateSocialProfileViewDefault($input: CreateSocialProfileViewInput!) {
  createSocialProfileView(input: $input) {
    socialProfileView {
      id
      name
      filters
    }
    userErrors {
      field
      message
    }
  }
}

variables.json

{
  "input": {
    "name": "Verified Instagram Creators",
    "filters": {
      "platform": "instagram"
    }
  }
}

Headers

Authorization: Bearer docs_demo_token_0000000000000000000000
WORKSPACE-ID: 6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a

Request · cURL

curl https://app.archive.com/api/v2 \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer docs_demo_token_0000000000000000000000' \
  -H 'WORKSPACE-ID: 6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a' \
  -d '{
  "query": "mutation CreateSocialProfileViewDefault($input: CreateSocialProfileViewInput!) {\n  createSocialProfileView(input: $input) {\n    socialProfileView {\n      id\n      name\n      filters\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
  "variables": {
    "input": {
      "name": "Verified Instagram Creators",
      "filters": {
        "platform": "instagram"
      }
    }
  }
}'

Request · Node.js

const response = await fetch("https://app.archive.com/api/v2", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer docs_demo_token_0000000000000000000000",
    "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a"
  },
  body: JSON.stringify({
    query: `mutation CreateSocialProfileViewDefault($input: CreateSocialProfileViewInput!) {
  createSocialProfileView(input: $input) {
    socialProfileView {
      id
      name
      filters
    }
    userErrors {
      field
      message
    }
  }
}`,
    variables: {
      "input": {
        "name": "Verified Instagram Creators",
        "filters": {
          "platform": "instagram"
        }
      }
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  mutation CreateSocialProfileViewDefault($input: CreateSocialProfileViewInput!) {
    createSocialProfileView(input: $input) {
      socialProfileView {
        id
        name
        filters
      }
      userErrors {
        field
        message
      }
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "input" => { "name" => "Verified Instagram Creators", "filters" => { "platform" => "instagram" } } } }.to_json,
  "Content-Type" => "application/json",
  "Authorization" => "Bearer docs_demo_token_0000000000000000000000",
  "WORKSPACE-ID" => "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a"
)
puts response.body

Request · Python

import json
import requests

query = """
mutation CreateSocialProfileViewDefault($input: CreateSocialProfileViewInput!) {
  createSocialProfileView(input: $input) {
    socialProfileView {
      id
      name
      filters
    }
    userErrors {
      field
      message
    }
  }
}
"""

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query, "variables": {"input": {"name": "Verified Instagram Creators", "filters": {"platform": "instagram"}}}},
    headers={
        "Authorization": "Bearer docs_demo_token_0000000000000000000000",
        "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a",
    },
)
print(json.dumps(response.json(), indent=2))

200 OK 14 lines

{
  "data": {
    "createSocialProfileView": {
      "socialProfileView": {
        "id": "da1a2150-f024-5e82-ac3f-14bdea821079",
        "name": "Verified Instagram Creators",
        "filters": {
          "platform": "instagram"
        }
      },
      "userErrors": []
    }
  }
}