Frontify GraphQL Reference

https://frontify.github.io/graphql-reference
Admin
This is a comprehensive reference documenting the GraphQL API for the Frontify platform, detailing...
Tokens:154,935
Snippets:2,365
Trust Score:8.3
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### UpdateGuidelineDesignSettingsButtonStyleDataInput

Source: https://frontify.github.io/graphql-reference/type/UpdateGuidelineDesignSettingsButtonStyleDataInput

Documentation for the GraphQL input object UpdateGuidelineDesignSettingsButtonStyleDataInput, including its fields and an example usage.

```APIDOC
## Input Object: UpdateGuidelineDesignSettingsButtonStyleDataInput

### Description
Input object for updating the design settings of a button style in guideline design settings. This object is used as an argument in a mutation to update button style properties.

### Fields

- **key** (String!) - Required - Key of the `Button Style` to update.
- **fontFamily** (GuidelineDesignSettingsTypeStyleFontFamilyInput) - Optional - The font family.
- **fontSize** (String!) - Required - The size of the font, e.g.: "12px", "24pt", "2em". Supported units: px, pt, pc, in, mm, cm, em, rem, %, vw, vh.
- **fontWeight** (String!) - Required - The weight of the font, e.g. "100", "200", "300", "400", "500", "600", "700", "800", "900".
- **lineHeight** (String!) - Required - Line height.
- **isUppercase** (Boolean!) - Required - Whether the text is uppercase.
- **isItalic** (Boolean!) - Required - Whether the text is italic.
- **paddingTop** (String) - Optional - The top padding, e.g. "10px". Supported units: "px", "pt", "pc", "in", "mm", "cm", "em", "rem", "%", "vw", "vh".
- **paddingRight** (String) - Optional - The right padding, e.g. "10px". Supported units: "px", "pt", "pc", "in", "mm", "cm", "em", "rem", "%", "vw", "vh".
- **paddingBottom** (String) - Optional - The bottom padding, e.g. "10px". Supported units: "px", "pt", "pc", "in", "mm", "cm", "em", "rem", "%", "vw", "vh".
- **paddingLeft** (String) - Optional - The left padding, e.g. "10px". Supported units: "px", "pt", "pc", "in", "mm", "cm", "em", "rem", "%", "vw", "vh".
- **cornerRadius** (String) - Optional - The corner radius, e.g. "5px".
- **borderWidth** (String) - Optional - The border width, e.g. "5px".

### Example

```graphql
mutation {
  updateGuidelineDesignSettingsButtonStyle(
    input: {
      key: "primary"
      fontFamily: {}
      fontSize: "16px"
      fontWeight: "400"
      lineHeight: "1.5"
      isUppercase: false
      isItalic: false
      paddingTop: "10px"
      paddingRight: "10px"
      paddingBottom: "10px"
      paddingLeft: "10px"
      cornerRadius: "5px"
      borderWidth: "1px"
    }
  ) {
    # response fields
  }
}
```
```

--------------------------------

### installProjectWebhook

Source: https://frontify.github.io/graphql-reference/mutations/installProjectWebhook

Documentation for the installProjectWebhook mutation, including its input fields and return type.

```APIDOC
## Mutation installProjectWebhook

### Description
Installs a `Webhook` for a `Project`. Requires `basic:write` and `webhook:write` scopes and `Project` permission level `EDIT`.

### Method
Mutation

### Endpoint
installProjectWebhook(input: InstallProjectWebhookInput!): InstallProjectWebhook

### Parameters
#### Input Fields (InstallProjectWebhookInput)
- **projectId** (ID!) - Required - Destination `Project` Id.
- **notificationUrl** (Url!) - Required - `Url` to send the `ProjectWebhook` notification to.
- **name** (String!) - Required - `ProjectWebhook` name.

### Response
#### Fields (InstallProjectWebhook)
- **webhook** (Webhook!) - `Webhook` details.

### Notes
All mutations have exactly one input field called `input` with a unique input and return type. This is useful to write mutations with variables, so there is always one single variable per mutation.
```

--------------------------------

### InstallProjectWebhook

Source: https://frontify.github.io/graphql-reference/type/InstallProjectWebhook

GraphQL object type with a field 'webhook' that returns Webhook details.

```APIDOC
## InstallProjectWebhook

### Description
GraphQL object type representing a webhook installation for a project.

### Fields
- **webhook** (Webhook!) - Webhook details.

```

--------------------------------

### DateTimeRangeInput

Source: https://frontify.github.io/graphql-reference/type/DateTimeRangeInput

GraphQL input object type for specifying a date-time range. It contains two optional fields: from and to, representing the start and end of the range.

```APIDOC
## DateTimeRangeInput

### Description
GraphQL input object type for specifying a date-time range.

### Fields
- **from** (DateTime) - Optional - Start `DateTime` of the range.
- **to** (DateTime) - Optional - End `DateTime` of the range.

```

--------------------------------

### AssetDateRangeInput

Source: https://frontify.github.io/graphql-reference/type/AssetDateRangeInput

GraphQL input object type representing an inclusive date range. It contains two required DateTime fields: 'from' (start of the range) and 'to' (end of the range).

```APIDOC
## AssetDateRangeInput

### Description
Inclusive date range.

### Input Fields
- **from** (DateTime!) - Required - Start of the range (inclusive).
- **to** (DateTime!) - Required - End of the range (inclusive).

```

--------------------------------

### createGuidelineDocumentLink

Source: https://frontify.github.io/graphql-reference/mutations/createGuidelineDocumentLink

Creates a new guideline document link. The mutation takes a single input object with required parentId, title, url, and openNewTab fields, plus optional displayMode, iconPosition, iconAssetId, and iconFileId. Returns the created link with its ID and configuration.

```APIDOC
## createGuidelineDocumentLink

### Description
Creates a new guideline document link under a specified parent (Guideline or Document Group). The mutation accepts a single input object and returns the created link's details.

### Method
Mutation

### Endpoint
createGuidelineDocumentLink(input: CreateGuidelineDocumentLinkInput!): CreateGuidelineDocumentLink

### Parameters
#### Input Fields (CreateGuidelineDocumentLinkInput)
- **parentId** (ID!) - Required - The parent ID to create the link in (Guideline or Document Group)
- **title** (String!) - Required - The title of the link.
- **url** (String!) - Required - The link URL
- **openNewTab** (Boolean!) - Required - Whether the link opens in a new tab.
- **displayMode** (GuidelineDocumentLinkDisplayMode) - Optional (default: null) - How the link is displayed.
- **iconPosition** (GuidelineDocumentLinkIconPosition) - Optional (default: null) - Position of the icon relative to the label.
- **iconAssetId** (ID) - Optional (default: null) - Icon taken from an asset ID; `null` clears the icon. Mutually exclusive with `iconFileId`.
- **iconFileId** (String) - Optional (default: null) - Icon taken from an uploaded file id; `null` clears the icon. Mutually exclusive with `iconAssetId`.

### Request Example
```graphql
mutation CreateGuidelineDocumentLink($input: CreateGuidelineDocumentLinkInput!) {
  createGuidelineDocumentLink(input: $input) {
    id
    title
    url
    openNewTab
    displayMode
    iconPosition
    iconAssetId
    iconFileId
  }
}
```

### Response
#### Success Response
Returns the created link with the following fields:
- **id** (ID!) - The link document's ID
- **title** (String!) - The title of the link.
- **url** (String!) - The link URL
- **openNewTab** (Boolean!) - Whether the link opens in a new tab.
- **displayMode** (GuidelineDocumentLinkDisplayMode) - How the link is displayed.
- **iconPosition** (GuidelineDocumentLinkIconPosition) - Position of the icon relative to the label.
- **iconAssetId** (ID) - Icon asset ID, if the icon comes from an asset.
- **iconFileId** (String) - Icon file id, if the icon comes from an uploaded file.

#### Response Example
```json
{
  "data": {
    "createGuidelineDocumentLink": {
      "id": "123",
      "title": "Example Link",
      "url": "https://example.com",
      "openNewTab": true,
      "displayMode": "INLINE",
      "iconPosition": "LEFT",
      "iconAssetId": "asset-456",
      "iconFileId": null
    }
  }
}
```
```

--------------------------------

### MarkingTimeframeInput

Source: https://frontify.github.io/graphql-reference/type/MarkingTimeframeInput

GraphQL input object type for specifying a timeframe within a video marking. It contains start and end fields of type Percent, representing the beginning and end of the marking area as percentages of the total video length.

```APIDOC
## MarkingTimeframeInput

### Description
GraphQL input object type for specifying a timeframe within a video marking. It contains start and end fields of type Percent, representing the beginning and end of the marking area as percentages of the total video length.

### Fields
- **start** (Percent) - Optional - The start of the `Marking` area in percentage of total video length. Defaults to video start (0) when the timeframe input property is set.
- **end** (Percent) - Optional - The end of the `Marking` area in percentage of total video length. Defaults to video end (1) when the timeframe input property is set.
```

--------------------------------

### updateGuidelineDocumentLink

Source: https://frontify.github.io/graphql-reference/mutations/updateGuidelineDocumentLink

Documentation for the updateGuidelineDocumentLink mutation, including input fields and return fields.

```APIDOC
## Mutation: updateGuidelineDocumentLink

### Description
Updates a guideline document link with the provided input. This mutation is in Beta.

### Method
mutation

### Endpoint
updateGuidelineDocumentLink(input: UpdateGuidelineDocumentLinkInput!): UpdateGuidelineDocumentLink

### Parameters
#### Input Fields (UpdateGuidelineDocumentLinkInput)
- **id** (ID!) - Required - The ID of the guideline document link to update.
- **language** (String) - Optional - Language code the title is written in. Only meaningful together with `title`. Omit it (or pass the default language) to update the base title; pass a non-default language to update that translation.
- **title** (String) - Optional - The new title of the link.
- **url** (String) - Optional - The link URL.
- **openNewTab** (Boolean) - Optional - Whether the link opens in a new tab.
- **displayMode** (GuidelineDocumentLinkDisplayMode) - Optional - How the link is displayed.
- **iconPosition** (GuidelineDocumentLinkIconPosition) - Optional - Position of the icon relative to the label.
- **iconAssetId** (ID) - Optional - Icon taken from an asset id; `null` clears the icon. Mutually exclusive with `iconFileId`.
- **iconFileId** (String) - Optional - Icon taken from an uploaded file id; `null` clears the icon. Mutually exclusive with `iconAssetId`.

### Response
#### Fields (UpdateGuidelineDocumentLink)
- **id** (ID!) - The ID of the updated document link.
- **title** (String) - The title of the link after the update.
- **url** (String) - The link URL after the update.
- **openNewTab** (Boolean!) - Whether the link opens in a new tab.
- **displayMode** (GuidelineDocumentLinkDisplayMode) - How the link is displayed.
- **iconPosition** (GuidelineDocumentLinkIconPosition) - Position of the icon relative to the label.
- **iconAssetId** (ID) - Icon asset ID, if the icon comes from an asset.
- **iconFileId** (String) - Icon file id, if the icon comes from an uploaded file.

### Example
```graphql
mutation UpdateGuidelineDocumentLink($input: UpdateGuidelineDocumentLinkInput!) {
  updateGuidelineDocumentLink(input: $input) {
    id
    title
    url
    openNewTab
    displayMode
    iconPosition
    iconAssetId
    iconFileId
  }
}
```
```

--------------------------------

### createLicense(input: CreateLicenseInput!): CreateLicense

Source: https://frontify.github.io/graphql-reference/mutations/createLicense

Creates a new Project License. Requires basic:write scope and Project permission level EDIT. The mutation accepts a single input object and returns the created License.

```APIDOC
## createLicense(input: CreateLicenseInput!): CreateLicense

### Description
Creates a new `Project` `License`. Requires `basic:write` scope and `Project` permission level `EDIT`.

### Method
Mutation

### Endpoint
createLicense

### Parameters
#### Input Fields (CreateLicenseInput)
- **projectId** (ID!) - Required - `Library` Id.
- **title** (String!) - Required - `License` title.
- **license** (String!) - Required - `License` terms.
- **addByDefault** (Boolean) - Optional - Apply `License` to new assets by default. Default: false.
- **requireConsensus** (Boolean) - Optional - Require user to accept `License` terms before download. Default: false.

### Request Example
```graphql
mutation {
  createLicense(input: {
    projectId: "project-id"
    title: "License Title"
    license: "License terms"
    addByDefault: false
    requireConsensus: false
  }) {
    license {
      # License fields
    }
  }
}
```

### Response
#### Success Response
- **license** (License!) - `License` details.

#### Response Example
```graphql
{
  "data": {
    "createLicense": {
      "license": {
        "id": "license-id",
        "title": "License Title",
        "license": "License terms",
        "addByDefault": false,
        "requireConsensus": false
      }
    }
  }
}
```
```

--------------------------------

### createGuidelineDocumentPageLink

Source: https://frontify.github.io/graphql-reference/mutations/createGuidelineDocumentPageLink

Documentation for the createGuidelineDocumentPageLink mutation, including input and return fields.

```APIDOC
## createGuidelineDocumentPageLink

### Description
Creates a new guideline document page link. This mutation is in Beta.

### Mutation
createGuidelineDocumentPageLink(input: CreateGuidelineDocumentPageLinkInput!): CreateGuidelineDocumentPageLink

### Input Fields
- **parentId** (ID!) - Required - The ID of the entity to create the link in (GuidelineDocument or GuidelineDocumentPageCategory).
- **title** (String!) - Required - The title of the link.
- **url** (String!) - Required - The link URL.
- **openNewTab** (Boolean = null) - Optional - Whether the link opens in a new tab. When omitted, the link opens in a new tab.
- **displayMode** (GuidelineDocumentLinkDisplayMode = null) - Optional - How the link is displayed.
- **iconPosition** (GuidelineDocumentLinkIconPosition = null) - Optional - Position of the icon relative to the label.
- **iconAssetId** (ID = null) - Optional - Icon taken from an asset ID. Mutually exclusive with `iconFileId`.
- **iconFileId** (String = null) - Optional - Icon taken from an uploaded file id. Mutually exclusive with `iconAssetId`.

### Return Fields
- **id** (ID!) - The ID of the created document page link.
- **title** (String) - The title of the created document page link.
- **url** (String) - The link URL of the created document page link.
- **openNewTab** (Boolean!) - Whether the link opens in a new tab.
- **displayMode** (GuidelineDocumentLinkDisplayMode) - How the link is displayed.
- **iconPosition** (GuidelineDocumentLinkIconPosition) - Position of the icon relative to the label.
- **iconAssetId** (ID) - Icon asset ID, if the icon comes from an asset.
- **iconFileId** (String) - Icon file id, if the icon comes from an uploaded file.

### Example
```graphql
mutation CreateGuidelineDocumentPageLink($input: CreateGuidelineDocumentPageLinkInput!) {
  createGuidelineDocumentPageLink(input: $input) {
    id
    title
    url
    openNewTab
    displayMode
    iconPosition
    iconAssetId
    iconFileId
  }
}
```
```

--------------------------------

### Guideline.navigation

Source: https://frontify.github.io/graphql-reference/type/Guideline

Returns paginated navigation items for the Guideline, with optional language override.

```APIDOC
## Guideline.navigation

### Description
Returns paginated navigation items for `Guideline`. The `language` argument must be set at the highest applicable level within the query (e.g. on `brand.guidelines`); when omitted here, the language already set upstream is reused.

### Method
QUERY

### Endpoint
Guideline.navigation

### Parameters
#### Query Parameters
- **language** (String) - Optional - Default: null - The language code for the navigation items.
- **limit** (Int) - Optional - Default: 100 - The maximum number of items to return.
- **page** (Int) - Optional - Default: 1 - The page number for pagination.

### Response
#### Success Response (200)
- **items** (GuidelineNavigationItems) - The paginated navigation items.

#### Response Example
```json
{
  "data": {
    "navigation": {
      "items": []
    }
  }
}
```
```

--------------------------------

### updateGuidelineDesignSettingsBulletListStyles

Source: https://frontify.github.io/graphql-reference/mutations/updateGuidelineDesignSettingsBulletListStyles

Documentation for the updateGuidelineDesignSettingsBulletListStyles mutation, including its input fields and return type.

```APIDOC
## Mutation: updateGuidelineDesignSettingsBulletListStyles

### Description
Updates the existing `Bullet List Styles` of a `Guideline`. This mutation accepts a single input object and returns the updated bullet list styles.

### Method
Mutation

### Endpoint
updateGuidelineDesignSettingsBulletListStyles(input: UpdateGuidelineDesignSettingsBulletListStylesInput!): UpdateGuidelineDesignSettingsBulletListStyles

### Parameters
#### Input Fields (UpdateGuidelineDesignSettingsBulletListStylesInput)
- **guidelineId** (ID!) - Required - The `Guideline` Id.
- **data** ([UpdateGuidelineDesignSettingsBulletListStylesDataInput]!) - Required - `Bullet List Styles` data.

### Request Example
```graphql
mutation UpdateGuidelineDesignSettingsBulletListStyles($input: UpdateGuidelineDesignSettingsBulletListStylesInput!) {
  updateGuidelineDesignSettingsBulletListStyles(input: $input) {
    bulletListStyles {
      # fields of GuidelineDesignSettingsBulletListStyle
    }
  }
}
```

### Response
#### Success Response
- **bulletListStyles** ([GuidelineDesignSettingsBulletListStyle]!) - `Bullet List Styles` details.

#### Response Example
```graphql
{
  "data": {
    "updateGuidelineDesignSettingsBulletListStyles": {
      "bulletListStyles": [
        {
          # fields of GuidelineDesignSettingsBulletListStyle
        }
      ]
    }
  }
}
```
```

--------------------------------

### createFolder(input: CreateFolderInput!): CreateFolder

Source: https://frontify.github.io/graphql-reference/mutations/createFolder

Creates a new Folder with the specified parent and name.

```APIDOC
## Mutation: createFolder

### Description
Creates a new `Folder` in the specified parent. Requires `basic:write` scope and `EDIT` permission on the `Project` or `Folder`.

### Method
Mutation

### Endpoint
createFolder(input: CreateFolderInput!): CreateFolder

### Parameters
#### Input Fields (CreateFolderInput)
- **parentId** (ID!) - Required - The parent Id of the `Folder` creation destination. Possible identifiers are `Library`/`Workspace` or `Folder`.
- **name** (String!) - Required - `Folder` name.
- **description** (String) - Optional - `Folder` description.

### Request Example
```graphql
mutation CreateFolder($input: CreateFolderInput!) {
  createFolder(input: $input) {
    folder {
      id
      name
      description
    }
  }
}
```

### Response
#### Success Response
- **folder** (Folder) - The newly created `Folder`.
```

--------------------------------

### CreateCustomMetadataPropertyInput

Source: https://frontify.github.io/graphql-reference/type/CreateCustomMetadataPropertyInput

Documentation for the CreateCustomMetadataPropertyInput input object type, including its fields and descriptions.

```APIDOC
## CreateCustomMetadataPropertyInput

### Description
Input object type for creating a custom metadata property.

### Fields
- **parentId** (ID!) - Required - `CustomMetadataProperty` parent Id.
- **name** (String!) - Required - `CustomMetadataProperty` display name.
- **type** (CreateCustomMetadataPropertyTypeInput!) - Required - `CustomMetadataProperty` type.
- **helpText** (String = "") - Optional - `CustomMetadataProperty` help text.
- **isRequired** (Boolean = false) - Optional - Define if `CustomMetadataProperty` is required.
- **isViewable** (Boolean! = true) - Optional - Beta - Define if `CustomMetadataProperty` is viewable.
- **isSearchable** (Boolean! = true) - Optional - Beta - Define if `CustomMetadataProperty` is searchable.
- **defaultValue** (String) - Optional - Set a `CustomMetadataProperty` default value. This setting will be ignored for properties that are not of `SELECT` or `MULTISELECT` type (use options for these cases instead). Applies to newly uploaded `Assets` only.
- **position** (CustomMetadataPropertyPositionInput) - Optional - Position in the list of newly created `CustomMetadataProperty`.
- **dependency** (CustomMetadataPropertyDependencyInput) - Optional - Beta - Set a dependency to another `CustomMetadataProperty`.
- **permissions** ([CustomMetadataPropertyPermissionInput!]) - Optional - Beta - Permissions defined for this property.
```

--------------------------------

### createGuidelinePageSection

Source: https://frontify.github.io/graphql-reference/mutations/createGuidelinePageSection

Documentation for the createGuidelinePageSection mutation, including its input fields and return type.

```APIDOC
## Mutation createGuidelinePageSection

### Description
Creates a new `GuidelinePageSection`, either on top of a page or after a given section.

### Method
Mutation

### Endpoint
createGuidelinePageSection(input: CreateGuidelinePageSectionInput!): CreateGuidelinePageSection

### Parameters
#### Input Fields (CreateGuidelinePageSectionInput)
- **pageId** (ID!) - Required - The `id` of `GuidelinePage` on which the `GuidelinePageSection` should be inserted.
- **afterGuidelinePageSectionId** (ID) - Optional - The `id` of the `GuidelinePageSection` after which the newly created `GuidelinePageSection` should be inserted. If null or undefined, the `GuidelinePageSection` will be inserted at the beginning of the `GuidelinePage`.

### Response
#### Fields (CreateGuidelinePageSection)
- **section** (GuidelinePageSection!) - The `GuidelinePageSection` that was just created.

### Example
```graphql
mutation CreateGuidelinePageSection($input: CreateGuidelinePageSectionInput!) {
  createGuidelinePageSection(input: $input) {
    section {
      id
    }
  }
}
```
```

--------------------------------

### CreateAssetCommentInput

Source: https://frontify.github.io/graphql-reference/type/CreateAssetCommentInput

Documentation for the CreateAssetCommentInput GraphQL input object type, including its fields and descriptions.

```APIDOC
## CreateAssetCommentInput

### Description
Input object type for creating an `AssetComment` on an `Asset`.

### Fields
- **assetId** (ID!) - Required - Id of the `Asset` where you wish to create a new `AssetComment`.
- **content** (String!) - Required - `AssetComment` content. Can include `User` mentions by wrapping an authorized `Project` `User` Id in the form of `@[user:<id>]` where `<id>` is the `User` integer or global identifier.
- **marking** (MarkingInput) - Optional - Add a `Marking` (highlighted area) to the new `AssetComment`.
```

--------------------------------

### CreateGuidelineDocumentLinkInput

Source: https://frontify.github.io/graphql-reference/type/CreateGuidelineDocumentLinkInput

Input object type for creating a guideline document link. Contains fields for parent ID, title, URL, open-in-new-tab flag, display mode, icon position, and icon identifiers.

```APIDOC
## CreateGuidelineDocumentLinkInput

### Description
Input for create a guideline document link.

### Fields
- **parentId** (ID!) - Required - The parent ID to create the link in (Guideline or Document Group)
- **title** (String!) - Required - The title of the link.
- **url** (String!) - Required - The link URL
- **openNewTab** (Boolean!) - Required - Whether the link opens in a new tab.
- **displayMode** (GuidelineDocumentLinkDisplayMode) - Optional - How the link is displayed. Default: null
- **iconPosition** (GuidelineDocumentLinkIconPosition) - Optional - Position of the icon relative to the label. Default: null
- **iconAssetId** (ID) - Optional - Icon taken from an asset ID; `null` clears the icon. Mutually exclusive with `iconFileId`. Default: null
- **iconFileId** (String) - Optional - Icon taken from an uploaded file id; `null` clears the icon. Mutually exclusive with `iconAssetId`. Default: null
```

--------------------------------

### showGuidelineDocumentLibraryInNavigation

Source: https://frontify.github.io/graphql-reference/mutations/showGuidelineDocumentLibraryInNavigation

Shows a guideline document library in the navigation. This mutation accepts an input object containing the library ID and returns the updated library with its navigation visibility status.

```APIDOC
## showGuidelineDocumentLibraryInNavigation

### Description
Shows a guideline document library in the navigation. This mutation accepts an input object containing the library ID and returns the updated library with its navigation visibility status.

### Method
Mutation

### Endpoint
showGuidelineDocumentLibraryInNavigation(input: ShowGuidelineDocumentLibraryInNavigationInput!): ShowGuidelineDocumentLibraryInNavigation

### Parameters
#### Input Fields (ShowGuidelineDocumentLibraryInNavigationInput)
- **id** (ID!) - Required - The ID of the guideline document library to show in the navigation.

### Response
#### Fields (ShowGuidelineDocumentLibraryInNavigation)
- **id** (ID!) - The ID of the guideline document library shown in the navigation.
- **isHiddenInNavigation** (Boolean!) - Whether or not the guideline document library is hidden in navigation.

```

--------------------------------

### createGuidelineDocumentLibrary

Source: https://frontify.github.io/graphql-reference/mutations/createGuidelineDocumentLibrary

Creates a new document library in a Guideline or Document Group. The mutation takes a single input object with required parentId, title, and libraryId, and optional heading and subheading. Returns the created library's ID, title, heading, and subheading.

```APIDOC
## createGuidelineDocumentLibrary

### Description
Creates a new document library within a Guideline or Document Group. The mutation requires a parent entity ID, a title, and a library ID, and optionally accepts a heading and subheading.

### Mutation
createGuidelineDocumentLibrary(input: CreateGuidelineDocumentLibraryInput!): CreateGuidelineDocumentLibrary

### Input Fields (CreateGuidelineDocumentLibraryInput)
- **parentId** (ID!) - Required - The ID of the entity to create the document library in (Guideline or Document Group).
- **title** (String!) - Required - The title of the document library.
- **libraryId** (ID!) - Required - The library ID.
- **heading** (String) - Optional - The heading of the document library. Defaults to null.
- **subheading** (String) - Optional - The subheading of the document library. Defaults to null.

### Return Fields (CreateGuidelineDocumentLibrary)
- **id** (ID!) - The ID of the created document library.
- **title** (String) - The title of the created document.
- **heading** (String!) - The heading of the created document.
- **subheading** (String!) - The subheading of the created document.

### Example Request
```graphql
mutation CreateGuidelineDocumentLibrary($input: CreateGuidelineDocumentLibraryInput!) {
  createGuidelineDocumentLibrary(input: $input) {
    id
    title
    heading
    subheading
  }
}
```

### Example Variables
```json
{
  "input": {
    "parentId": "<parent-id>",
    "title": "My Document Library",
    "libraryId": "<library-id>",
    "heading": "Optional Heading",
    "subheading": "Optional Subheading"
  }
}
```

### Example Response
```json
{
  "data": {
    "createGuidelineDocumentLibrary": {
      "id": "<created-id>",
      "title": "My Document Library",
      "heading": "Optional Heading",
      "subheading": "Optional Subheading"
    }
  }
}
```
```

--------------------------------

### CreateAssetInput

Source: https://frontify.github.io/graphql-reference/type/CreateAssetInput

Documentation for the CreateAssetInput input object type, listing all its fields with types, descriptions, and deprecation notes.

```APIDOC
## CreateAssetInput

### Description
Input object type for creating an `Asset`. No description provided.

### Fields

- **projectId** (ID) - Deprecated. `Library` or `Workspace` Id. This value is ignored if `parentId` is set. Removal: 1 Jul 2023 — use parentId instead.
- **fileId** (ID!) - File Id. Signed Id returned in `uploadFile`.
- **title** (String!) - `Asset` title or display name.
- **alternativeText** (String) - Alternative text for the `Asset`. Used by screen readers when the asset is not decorative.
- **isDecorative** (Boolean) - Indicates whether the `Asset` is decorative and not meant to be read by screen readers. If true, alternative text is ignored.
- **description** (String, default: "") - `Asset` description.
- **externalId** (ID) - `Asset` external Id.
- **copyright** (CreateCopyrightInput) - Add `Asset` copyright details.
- **tags** ([TagInput]) - List of tags to create with `Asset`.
- **skipFileMetadata** (Boolean, default: false) - Skip file's EXIF metadata. When true, it will ignore all file metadata contents.
- **directory** ([String]) - An array of strings representing the directory, if a folder does not exist, it is created. Example: ["My Folder", "Sub-Folder"] will create the necessary folders if they do not yet exist and place the `Asset` in it. **Important:** Cannot be used in conjunction with `parentId` that is from a `Folder`.
- **parentId** (ID) - The parent Id, where the `Asset` should be located in. Should either be a `Library`, `WorkspaceProject` or `Folder` Id. **Important:** Cannot be used in conjunction with `directory` if the Id is from a `Folder`.
- **workflowStatus** (String) - Deprecated. `Asset` workflow status. Workflow logic will be automatically managed if not properly set. Removal: 1 Jul 2022.
- **availability** (DateTimeRangeInput) - `Asset` will become available only during the interval. When undefined or `null` the `Asset` will be immediately and indefinitely available.
- **expiresAt** (DateTime) - `Asset` will expire once the defined date is reached.
- **author** (String, default: "") - Represents the Author of the `Asset`. Example: Photographer Name.
- **previewBackgroundColor** (RgbaColorInput) - Beta. Background color of the `Asset` preview.
```

--------------------------------

### updateGuidelineDocumentPageCategory

Source: https://frontify.github.io/graphql-reference/mutations/updateGuidelineDocumentPageCategory

Documentation for the updateGuidelineDocumentPageCategory mutation, including its input fields and return type.

```APIDOC
## Mutation: updateGuidelineDocumentPageCategory

### Description
Updates the title of a guideline document page category. This mutation accepts a single `input` argument and returns the updated category details.

### Method
Mutation

### Endpoint
updateGuidelineDocumentPageCategory(input: UpdateGuidelineDocumentPageCategoryInput!): UpdateGuidelineDocumentPageCategory

### Parameters
#### Input Fields (UpdateGuidelineDocumentPageCategoryInput)
- **id** (ID!) - Required - The ID of the guideline document page category to update.
- **title** (String!) - Required - The new title of the document page category.
- **language** (String) - Optional - Language code the title is written in. Omit it (or pass the default language) to update the base title; pass a non-default language to update that translation.

### Response
#### Fields (UpdateGuidelineDocumentPageCategory)
- **id** (ID!) - The ID of the updated document page category.
- **title** (String) - The title of the document page category after the update.

### Example
```graphql
mutation UpdateGuidelineDocumentPageCategory($input: UpdateGuidelineDocumentPageCategoryInput!) {
  updateGuidelineDocumentPageCategory(input: $input) {
    id
    title
  }
}
```
```

--------------------------------

### showGuidelineDocumentPageInNavigation

Source: https://frontify.github.io/graphql-reference/mutations/showGuidelineDocumentPageInNavigation

Shows a guideline document page in the navigation. This mutation accepts an input object containing the page ID and returns the updated page with its ID and navigation visibility status.

```APIDOC
## Mutation: showGuidelineDocumentPageInNavigation

### Description
Shows a guideline document page in the navigation. This mutation accepts an input object containing the page ID and returns the updated page with its ID and navigation visibility status.

### Input
- **input** (ShowGuidelineDocumentPageInNavigationInput!) - Required - The input object for the mutation.

#### Input Fields of ShowGuidelineDocumentPageInNavigationInput
- **id** (ID!) - Required - The ID of the guideline document page to show in the navigation.

### Return Type
- **ShowGuidelineDocumentPageInNavigation** - The result object containing the updated page information.

#### Fields of ShowGuidelineDocumentPageInNavigation
- **id** (ID!) - The ID of the guideline document page shown in the navigation.
- **isHiddenInNavigation** (Boolean!) - Whether or not the guideline document page is hidden in navigation.

### Example Request
```graphql
mutation ShowGuidelineDocumentPageInNavigation($input: ShowGuidelineDocumentPageInNavigationInput!) {
  showGuidelineDocumentPageInNavigation(input: $input) {
    id
    isHiddenInNavigation
  }
}
```

### Example Variables
```json
{
  "input": {
    "id": "<guideline_document_page_id>"
  }
}
```

### Response Example
```json
{
  "data": {
    "showGuidelineDocumentPageInNavigation": {
      "id": "<guideline_document_page_id>",
      "isHiddenInNavigation": false
    }
  }
}
```
```

--------------------------------

### previewUrl

Source: https://frontify.github.io/graphql-reference/type/Image

Preview URL with optional width and height parameters.

```APIDOC
## previewUrl

### Description
Preview `Url` which has optional `width` and `height` URL parameters. If parameters are not specified, `Url` without any URL parameters will be returned.

### Arguments
- **width** (`Int`): Optional width for the preview URL.
- **height** (`Int`): Optional height for the preview URL.

### Returns
- **Url!**: Preview URL.
```

--------------------------------

### updateGuidelineDocumentPageLink

Source: https://frontify.github.io/graphql-reference/mutations/updateGuidelineDocumentPageLink

Documentation for the updateGuidelineDocumentPageLink mutation, including its input fields and return fields.

```APIDOC
## Mutation: updateGuidelineDocumentPageLink

### Description
Updates a guideline document page link with the provided input fields. This mutation is in Beta.

### Method
mutation

### Endpoint
updateGuidelineDocumentPageLink(input: UpdateGuidelineDocumentPageLinkInput!): UpdateGuidelineDocumentPageLink

### Parameters
#### Input Fields (UpdateGuidelineDocumentPageLinkInput)
- **id** (ID!) - Required - The ID of the guideline document page link to update.
- **language** (String) - Optional - Language code the title is written in. Only meaningful together with `title`. Omit it (or pass the default language) to update the base title; pass a non-default language to update that translation.
- **title** (String) - Optional - The new title of the link.
- **url** (String) - Optional - The link URL.
- **openNewTab** (Boolean) - Optional - Whether the link opens in a new tab.
- **displayMode** (GuidelineDocumentLinkDisplayMode) - Optional - How the link is displayed.
- **iconPosition** (GuidelineDocumentLinkIconPosition) - Optional - Position of the icon relative to the label.
- **iconAssetId** (ID) - Optional - Icon taken from an asset id; `null` clears the icon. Mutually exclusive with `iconFileId`.
- **iconFileId** (String) - Optional - Icon taken from an uploaded file id; `null` clears the icon. Mutually exclusive with `iconAssetId`.

### Response
#### Success Response
- **id** (ID!) - The ID of the updated document page link.
- **title** (String) - The title of the link after the update.
- **url** (String) - The link URL after the update.
- **openNewTab** (Boolean!) - Whether the link opens in a new tab.
- **displayMode** (GuidelineDocumentLinkDisplayMode) - How the link is displayed.
- **iconPosition** (GuidelineDocumentLinkIconPosition) - Position of the icon relative to the label.
- **iconAssetId** (ID) - Icon asset ID, if the icon comes from an asset.
- **iconFileId** (String) - Icon file id, if the icon comes from an uploaded file.
```

--------------------------------

### ShowGuidelineDocumentLibraryInNavigation

Source: https://frontify.github.io/graphql-reference/type/ShowGuidelineDocumentLibraryInNavigation

GraphQL object type with fields id and isHiddenInNavigation, both marked as Beta.

```APIDOC
## ShowGuidelineDocumentLibraryInNavigation

### Description
GraphQL object type representing a guideline document library's visibility in navigation. No description provided.

### Fields
- **id** (ID!) - Beta - The ID of the guideline document library shown in the navigation.
- **isHiddenInNavigation** (Boolean!) - Beta - Whether or not the guideline document library is hidden in navigation.

```

--------------------------------

### createWorkspaceProject(input: CreateWorkspaceProjectInput!): CreateWorkspaceProject

Source: https://frontify.github.io/graphql-reference/mutations/createWorkspaceProject

Creates a new Workspace type Project. Requires basic:write scope. The input must include brandId and name, and the mutation returns the created WorkspaceProject.

```APIDOC
## createWorkspaceProject(input: CreateWorkspaceProjectInput!): CreateWorkspaceProject

### Description
Creates a new `Workspace` type `Project`. Requires `basic:write` scope to be accessible.

### Method
Mutation

### Endpoint
createWorkspaceProject

### Parameters
#### Input Fields (CreateWorkspaceProjectInput)
- **brandId** (ID!) - Required - Id of the `Brand` where `Project` should be inserted.
- **name** (String!) - Required - `Workspace` type `Project` name.

### Return Fields (CreateWorkspaceProject)
- **project** (Workspace!) - `WorkspaceProject` details.

### Request Example
```graphql
mutation {
  createWorkspaceProject(input: {
    brandId: "your-brand-id"
    name: "Your Project Name"
  }) {
    project {
      # Workspace fields
    }
  }
}
```

### Response Example
```json
{
  "data": {
    "createWorkspaceProject": {
      "project": {
        "id": "workspace-project-id",
        "name": "Your Project Name"
      }
    }
  }
}
```
```

--------------------------------

### showGuidelineDocumentGroupInNavigation

Source: https://frontify.github.io/graphql-reference/mutations/showGuidelineDocumentGroupInNavigation

Shows a guideline document group in the navigation. The mutation requires an input object containing the ID of the group, and returns the group with its updated navigation visibility.

```APIDOC
## Mutation: showGuidelineDocumentGroupInNavigation

### Description
Shows a guideline document group in the navigation. This mutation changes the visibility of the specified group so that it is no longer hidden in navigation.

### Input
- **input** (ShowGuidelineDocumentGroupInNavigationInput!) - Required - The input object containing the ID of the guideline document group.

#### Input Fields of ShowGuidelineDocumentGroupInNavigationInput
- **id** (ID!) - Required - The ID of the guideline document group to show in the navigation.

### Return Type
- **ShowGuidelineDocumentGroupInNavigation** - The result object containing the updated group information.

#### Fields of ShowGuidelineDocumentGroupInNavigation
- **id** (ID!) - The ID of the guideline document group shown in the navigation.
- **isHiddenInNavigation** (Boolean!) - Whether or not the guideline document group is hidden in navigation.

### Example
```graphql
mutation ShowGuidelineDocumentGroupInNavigation($input: ShowGuidelineDocumentGroupInNavigationInput!) {
  showGuidelineDocumentGroupInNavigation(input: $input) {
    id
    isHiddenInNavigation
  }
}
```

### Variables
```json
{
  "input": {
    "id": "<guideline_document_group_id>"
  }
}
```
```

--------------------------------

### createGuidelineDocumentPage

Source: https://frontify.github.io/graphql-reference/mutations/createGuidelineDocumentPage

Creates a new guideline document page under a specified parent. The parent can be either a GuidelineDocument or a GuidelineDocumentPageCategory. The mutation returns the created page's details including its ID, document ID, title, and category ID if applicable.

```APIDOC
## createGuidelineDocumentPage

### Description
Creates a new guideline document page under a specified parent. The parent can be either a GuidelineDocument or a GuidelineDocumentPageCategory. The mutation returns the created page's details including its ID, document ID, title, and category ID if applicable.

### Method
Mutation

### Endpoint
createGuidelineDocumentPage

### Parameters
#### Input Fields (CreateGuidelineDocumentPageInput)
- **parentId** (ID!) - Required - The ID of the parent where guideline document page should be created in. Can be either a GuidelineDocument or GuidelineDocumentPageCategory.
- **title** (String!) - Required - The title of the guideline document page.

### Request Example
```graphql
mutation CreateGuidelineDocumentPage($input: CreateGuidelineDocumentPageInput!) {
  createGuidelineDocumentPage(input: $input) {
    id
    documentId
    title
    categoryId
  }
}
```

### Response
#### Success Response (200)
- **id** (ID!) - The ID of the created guideline document page.
- **documentId** (ID!) - The ID of the document the guideline document page is created in.
- **title** (String!) - The title of the guideline document page.
- **categoryId** (ID) - The ID of the category the guideline document page is created in.

#### Response Example
```json
{
  "data": {
    "createGuidelineDocumentPage": {
      "id": "guideline-document-page-id",
      "documentId": "document-id",
      "title": "New Page",
      "categoryId": null
    }
  }
}
```
```

--------------------------------

### CreateFolderInput

Source: https://frontify.github.io/graphql-reference/type/CreateFolderInput

Input object type for creating a folder. Contains fields for parentId, name, and description.

```APIDOC
## CreateFolderInput

### Description
Input object type for creating a folder.

### Input Fields
- **parentId** (ID!) - Required - The parent Id of the `Folder` creation destination. Possible identifiers are `Library`/`Workspace` or `Folder`.
- **name** (String!) - Required - `Folder` name.
- **description** (String) - Optional - `Folder` description.
```

--------------------------------

### createGuidelineDocument

Source: https://frontify.github.io/graphql-reference/mutations/createGuidelineDocument

Creates a new guideline document under a specified parent entity (Guideline or Document Group). This mutation is part of the GraphQL API and is currently in Beta.

```APIDOC
## Mutation createGuidelineDocument

### Description
Creates a new guideline document under a specified parent entity (Guideline or Document Group). This mutation is part of the GraphQL API and is currently in Beta.

### Method
Mutation

### Endpoint
createGuidelineDocument(input: CreateGuidelineDocumentInput!): CreateGuidelineDocument

### Parameters
#### Input Fields (CreateGuidelineDocumentInput)
- **parentId** (ID!) - Required - The ID of the entity to create the document in (Guideline or Document Group).
- **title** (String!) - Required - The title of the document.

### Response
#### Success Response
- **id** (ID!) - The ID of the created document.
- **title** (String) - The title of the created document.

### Notes
- All mutations have exactly one input field called `input` with a unique input and return type. This is useful to write mutations with variables, so there is always one single variable per mutation.
```

--------------------------------

### showGuidelineDocumentInNavigation

Source: https://frontify.github.io/graphql-reference/mutations/showGuidelineDocumentInNavigation

Shows a guideline document in the navigation. Provide the ID of the guideline document as input. Returns the document ID and whether it is hidden in navigation.

```APIDOC
## Mutation showGuidelineDocumentInNavigation

### Description
Shows a guideline document in the navigation. This mutation changes the visibility of a guideline document so that it appears in the navigation.

### Method
Mutation

### Endpoint
showGuidelineDocumentInNavigation(input: ShowGuidelineDocumentInNavigationInput!): ShowGuidelineDocumentInNavigation

### Parameters
#### Input Fields (ShowGuidelineDocumentInNavigationInput)
- **id** (ID!) - Required - The ID of the guideline document to show in the navigation.

### Response
#### Fields (ShowGuidelineDocumentInNavigation)
- **id** (ID!) - The ID of the guideline document shown in the navigation.
- **isHiddenInNavigation** (Boolean!) - Whether or not the guideline document is hidden in navigation.

### Example
```graphql
mutation {
  showGuidelineDocumentInNavigation(input: {id: "your-document-id"}) {
    id
    isHiddenInNavigation
  }
}
```
```
Tokens:
Raw