Collections · Frontify GraphQL

Mutation

addCollectionAssets

Add Assets to the existing Collection. Requires basic:write scope to be accessible and Collection permission level EDIT.

Returns

AddCollectionAssets

Arguments

input:AddCollectionAssetsInput!Required: AddCollectionAssets input argument.; RequiredcollectionId: ID!, assetIds: [ID!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation AddCollectionAssets {
  addCollectionAssets(
    input: {
      collectionId: 
      assetIds: []
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "addCollectionAssets": {
      "__typename": "AddCollectionAssets"
    }
  }
}

Mutation

createCollection

Open full page ↗Raw SDL

Create a new Collection. Currently supported for Library type parent entities only. Requires basic:write scope to be accessible and Collection permission level EDIT.

Returns

CreateCollection

Arguments

input:CreateCollectionInput!Required: CreateCollection input argument.; RequiredparentId: ID!, name: String!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation CreateCollection {
  createCollection(
    input: {
      parentId: 
      name: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "createCollection": {
      "__typename": "CreateCollection"
    }
  }
}

Mutation

deleteCollection

Open full page ↗Raw SDL

Delete an existing Collection. Requires basic:write scope to be accessible and Collection permission level EDIT.

Returns

DeleteCollection

Arguments

input:DeleteCollectionInput!Required: DeleteCollection input argument.; RequiredcollectionId: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

idID!

Example

mutation DeleteCollection {
  deleteCollection(
    input: {
      collectionId: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "deleteCollection": {
      "__typename": "DeleteCollection",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Mutation

removeCollectionAssets

Open full page ↗Raw SDL

Remove Assets from the existing Collection. Requires basic:write scope to be accessible and Collection permission level EDIT.

Returns

RemoveCollectionAssets

Arguments

input:RemoveCollectionAssetsInput!Required: RemoveCollectionAssets input argument.; RequiredcollectionId: ID!, assetIds: [ID!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation RemoveCollectionAssets {
  removeCollectionAssets(
    input: {
      collectionId: 
      assetIds: []
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "removeCollectionAssets": {
      "__typename": "RemoveCollectionAssets"
    }
  }
}

Mutation

setCollectionAssets

Open full page ↗Raw SDL

Replace the existing set of the Assets in the Collection with the new set of the Assets. Requires basic:write scope to be accessible and Project permission level EDIT.

Returns

SetCollectionAssets

Arguments

input:SetCollectionAssetsInput!Required: SetCollectionAssets input argument.; RequiredcollectionId: ID!, assetIds: [ID!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation SetCollectionAssets {
  setCollectionAssets(
    input: {
      collectionId: 
      assetIds: []
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "setCollectionAssets": {
      "__typename": "SetCollectionAssets"
    }
  }
}

Mutation

updateCollection

Open full page ↗Raw SDL

Update an existing Collection. Requires basic:write scope to be accessible and Collection permission level EDIT.

Returns

UpdateCollection

Arguments

input:UpdateCollectionInput!Required: UpdateCollection input argument.; RequiredcollectionId: ID!, data: UpdateCollectionDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation UpdateCollection {
  updateCollection(
    input: {
      collectionId: 
      data: {
        name: 
      }
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "updateCollection": {
      "__typename": "UpdateCollection"
    }
  }
}