Metadata · Frontify GraphQL

Mutation

addCustomMetadata

Add CustomMetadata values to a supported parent (Asset | WorkspaceProject). Requires basic:write scope to be accessible and permission level EDIT for the respective parent.

Returns

AddCustomMetadata

Arguments

input:AddCustomMetadataInput!Required: AddCustomMetadata input argument.; RequiredparentIds: [ID!]!, customMetadata: [CustomMetadataInput!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

parentIds[ID!]!

Example

mutation AddCustomMetadata {
  addCustomMetadata(
    input: {
      parentIds: []
      customMetadata: [
        {
          propertyId: 
          
        }
        
      ]
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "addCustomMetadata": {
      "__typename": "AddCustomMetadata"
    }
  }
}

Mutation

addCustomMetadataPropertyOptions

Open full page ↗Raw SDL

Add options to an existing SELECT or MULTISELECT type CustomMetadataProperty. RequiresRequires basic:write scope to be accessible and CustomMetadataProperty permission level EDIT.

Returns

AddCustomMetadataPropertyOptions

Arguments

input:AddCustomMetadataPropertyOptionsInput!Required: AddCustomMetadataPropertyOptions input argument.; RequiredpropertyId: ID!, options: [AddCustomMetadataPropertyOptionInput!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation AddCustomMetadataPropertyOptions {
  addCustomMetadataPropertyOptions(
    input: {
      propertyId: 
      options: [
        {
          value: 
          
        }
        
      ]
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "addCustomMetadataPropertyOptions": {
      "__typename": "AddCustomMetadataPropertyOptions"
    }
  }
}

Mutation

createCustomMetadataProperty

Open full page ↗Raw SDL

Create a new CustomMetadataProperty. RequiresRequires basic:write scope to be accessible and Brand or Project permission level EDIT.

Returns

CreateCustomMetadataProperty

Arguments

input:CreateCustomMetadataPropertyInput!Required: CreateCustomMetadataProperty input argument.; RequiredparentId: ID!, name: String!, type: CreateCustomMetadataPropertyTypeInput!; OptionalhelpText: String, isRequired: Boolean, isViewable: Boolean!, isSearchable: Boolean!, defaultValue: String, position: CustomMetadataPropertyPositionInput, dependency: CustomMetadataPropertyDependencyInput, permissions: [CustomMetadataPropertyPermissionInput!]

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation CreateCustomMetadataProperty {
  createCustomMetadataProperty(
    input: {
      parentId: 
      name: 
      type: {
        name: 
        
        
      }
      
      
      
      
      
      
      
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "createCustomMetadataProperty": {
      "__typename": "CreateCustomMetadataProperty"
    }
  }
}

MutationDeprecated

createMetadataField

Open full page ↗Raw SDL

Create a new Project MetadataField with your desired configuration. Requires basic:write scope to be accessible and Project permission level EDIT.

Returns

CreateMetadataField

Arguments

input:CreateMetadataFieldInput!Required: CreateMetadataField input argument.; RequiredprojectId: ID!, label: String!; Optionaltype: MetadataFieldType!, values: [MetadataFieldValuesInput], defaultValue: String, allowMultipleValues: Boolean, allowEmptyValue: Boolean, isSearchable: Boolean, isEditable: Boolean, isVisible: Boolean

Response fields

0 selected

Toggle fields to tailor the query and response.

metadataFieldMetadataField!

Example

mutation CreateMetadataField {
  createMetadataField(
    input: {
      projectId: 
      label: 
      
      
      
      
      
      
      
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "createMetadataField": {
      "__typename": "CreateMetadataField"
    }
  }
}

Mutation

deleteCustomMetadataProperty

Open full page ↗Raw SDL

Delete an existing CustomMetadataProperty.

Returns

DeleteCustomMetadataProperty

Arguments

input:DeleteCustomMetadataPropertyInput!Required: DeleteCustomMetadataProperty input argument.; Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

idID!

Example

mutation DeleteCustomMetadataProperty {
  deleteCustomMetadataProperty(
    input: {
      id: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "deleteCustomMetadataProperty": {
      "__typename": "DeleteCustomMetadataProperty",
      "id": "eyJXXXXXXXX…"
    }
  }
}

MutationDeprecated

deleteMetadataField

Open full page ↗Raw SDL

Delete an existing Project MetadataField. Existing MetadataField's with the same value with be automatically removed. Requires basic:write scope to be accessible and Project permission level EDIT.

Returns

DeleteMetadataField

Arguments

input:DeleteMetadataFieldInput!Required: DeleteMetadataField input argument.; Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

idID!

Example

mutation DeleteMetadataField {
  deleteMetadataField(
    input: {
      id: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "deleteMetadataField": {
      "__typename": "DeleteMetadataField",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Mutation

removeCustomMetadata

Open full page ↗Raw SDL

Remove CustomMetadata values from a supported parent (Asset | WorkspaceProject). Requires basic:write scope to be accessible and permission level EDIT for the respective parent.

Returns

RemoveCustomMetadata

Arguments

input:RemoveCustomMetadataInput!Required: RemoveCustomMetadata input argument.; RequiredparentIds: [ID!]!, customMetadata: [CustomMetadataInput!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

parentIds[ID!]!

Example

mutation RemoveCustomMetadata {
  removeCustomMetadata(
    input: {
      parentIds: []
      customMetadata: [
        {
          propertyId: 
          
        }
        
      ]
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "removeCustomMetadata": {
      "__typename": "RemoveCustomMetadata"
    }
  }
}

Mutation

removeCustomMetadataPropertyOptions

Open full page ↗Raw SDL

Remove options from an existing SELECT or MULTISELECT type CustomMetadataProperty. RequiresRequires basic:write scope to be accessible and CustomMetadataProperty permission level EDIT.

Returns

RemoveCustomMetadataPropertyOptions

Arguments

input:RemoveCustomMetadataPropertyOptionsInput!Required: RemoveCustomMetadataPropertyOptions input argument.; RequiredpropertyId: ID!, optionIds: [ID!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation RemoveCustomMetadataPropertyOptions {
  removeCustomMetadataPropertyOptions(
    input: {
      propertyId: 
      optionIds: []
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "removeCustomMetadataPropertyOptions": {
      "__typename": "RemoveCustomMetadataPropertyOptions"
    }
  }
}

MutationDeprecated

removeMetadataValue

Open full page ↗Raw SDL

Remove existing MetadataField value.Existing relations to that MetadataField with the same value will be automatically removed.Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

RemoveMetadataValue

Arguments

input:RemoveMetadataValueInput!Required: RemoveMetadataValue input argument.; Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

Example

mutation RemoveMetadataValue {
  removeMetadataValue(
    input: {
      id: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "removeMetadataValue": {
      "__typename": "RemoveMetadataValue",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Mutation

setCustomMetadata

Open full page ↗Raw SDL

Set CustomMetadataProperty values to any supported parent (WorkspaceProject | Asset). Attention: Existing CustomMetadataProperty values for the selected parents will be overwritten and/or removed. Requires basic:write scope to be accessible and permission level EDIT for the respective parent.

Beta

Returns

SetCustomMetadata

Arguments

input:SetCustomMetadataInput!RequiredBeta: SetCustomMetadata input argument.; RequiredparentIds: [ID!]!, customMetadata: [CustomMetadataInput!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

parentIds[ID!]!

Example

mutation SetCustomMetadata {
  setCustomMetadata(
    input: {
      parentIds: []
      customMetadata: [
        {
          propertyId: 
          
        }
        
      ]
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "setCustomMetadata": {
      "__typename": "SetCustomMetadata"
    }
  }
}

Mutation

updateCustomMetadataProperty

Open full page ↗Raw SDL

Update an existing CustomMetadataProperty. RequiresRequires basic:write scope to be accessible and CustomMetadataProperty permission level EDIT.

Returns

UpdateCustomMetadataProperty

Arguments

input:UpdateCustomMetadataPropertyInput!Required: UpdateCustomMetadataProperty input argument.; Requiredid: ID!, data: UpdateCustomMetadataPropertyDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation UpdateCustomMetadataProperty {
  updateCustomMetadataProperty(
    input: {
      id: 
      data: {
        
        
        
        
        
        
        
        
        
      }
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "updateCustomMetadataProperty": {
      "__typename": "UpdateCustomMetadataProperty"
    }
  }
}