OBJECT
Mutation

Data update operations.
GraphQL Schema definition

type Mutation {
#   A patch operation on a model. The id is required to identify
#   the model, all other attributes should only be specified if
#   they are intended to be changed.
# 
#   @error not.found: If no model with the given id exists.
#   @error not.unique: If multiple models with the given id exist for this 
#   organization. Note this only applies
#  
#   when searching on a `field` other than `id`
# 
# Arguments
#   id: The id of the model to retrieve.
#   field: The id field to use, defaults to the primary identifier 
#   (id) but may also
#   be a secondary identifier if that id is only applied to a single model.
#   patch: A set of attributes to update on the model.
#   Only the specified fields will be updated.
patchModel(id: ID!, field: ModelIdField, patch: ModelPatch!): Model! 
#   Updates all the address components.  Any components that
#   are unspecified will be removed from the Address, this is
#   not a patch operation.
# 
#   @error not.found: If no model with the given id exists.
#   @error not.unique: If multiple models with the given id exist for this 
#   organization. Note this only applies
#   when searching on a `field` other than `id`
#   @error request.invalid: If the country code is not recognized or too many 
#   address lines are specified.
# 
# Arguments
#   id: undefined
#   field: undefined
#   streetAddressLines: The street address lines.  Each line of the 
#   address
#   should be separated as a new entry in the array.
#   Currently only 2 address lines are supported.
#   administrativeArea: The administrative area, exact definition 
#   varies based on location, but for US addresses this is the state.
#   locality: The locality, exact definition varies based on 
#   location, but for US addresses this is the city.
#   dependentLocality: The dependent locality, more specific than 
#   city, not often used in US addresses.
#   postalCode: undefined
#   sortingCode: undefined
#   countryCode: Two character ISO-3166 country code.
updateModelAddress(
id: ID!,
field: ModelIdField,
streetAddressLines: [String!],
administrativeArea: String,
locality: String,
dependentLocality: String,
postalCode: String,
sortingCode: String,
countryCode: String
): Model! 
#   Set a model to active or inactive.  Sometimes referred to as active or archived 
#   respectively.
#   If the model is already in the given state or in the process of changing to that
#   state this call will be idempotent.
# 
#   @error not.found: If no model with the given id exists.
#   @error not.unique: If multiple models with the given id exist for this 
#   organization. Note this only applies when searching on a `field` other than `id`
#   @error spaces.illegal.activation.change: If the account does not support 
#   archived spaces.
# 
# Arguments
#   id: The id of the model to retrieve.
#   field: The id field to use, defaults to the primary identifier 
#   (id) but may also
#   be a secondary identifier if that id is only applied to a single model.
#   state: The state to set the model to, active to unarchive, 
#   inactive to archive.
updateModelState(
id: ID!,
field: ModelIdField,
state: ModelStateChange!
): Model! 
#   Sets whether a model can only be seen by members of the organization (internal) 
#   or by anyone
#   with a link to the model (public).
# 
#   @error not.found: If no model with the given id exists.
#   @error not.unique: If multiple models with the given id exist for this 
#   organization. Note this only applies
#  
#   when searching on a `field` other than `id`
# 
# Arguments
#   id: The id of the model to retrieve.
#   field: The id field to use, defaults to the primary identifier 
#   (id) but may also
#   be a secondary identifier if that id is only applied to a single model.
#   visibility: Whether the model should be public or private.
updateModelVisibility(
id: ID!,
field: ModelIdField,
visibility: ModelVisibility!
): Model! 
# Arguments
#   modelId: The id of the model to add the Mattertag to.
#   field: The id field to use, defaults to the primary identifier 
#   (id) but may also
#   be a secondary identifier if that id is only applied to a single model.
#   mattertag: The Mattertag details to use for creating the 
#   Mattertag
addMattertag(
modelId: ID!,
field: ModelIdField,
mattertag: MattertagDetails
): Mattertag! 
#   A patch operation on a model. The id is required to identify
#   the model, all other attributes should only be specified if
#   they are intended to be changed.
# 
#   @error not.found: If no model with the given id exists.
#   @error not.unique: If multiple models with the given id exist for this 
#   organization. Note this only applies
#  
#   when searching on a `field` other than `id`
#   @error request.invalid: If any of the fields in the patch fail validation.
# 
# Arguments
#   modelId: The id of the model containing the Mattertag to patch.
#   field: The id field to use, defaults to the primary identifier 
#   (id) but may also
#   be a secondary identifier if that id is only applied to a single model.
#   mattertagId: The id of the the Mattertag to patch.
#   patch: undefined
patchMattertag(
modelId: ID!,
field: ModelIdField,
mattertagId: ID!,
patch: MattertagPatch!
): Mattertag! 
#   Sets the media associated with the Mattertag to be an external URL.
# 
#   @error not.found: If no model with the given id exists.
#   @error not.unique: If multiple models with the given id exist for this 
#   organization. Note this only applies
#  
#   when searching on a `field` other than `id`
#   @error request.invalid If url is not a valid url.
# 
# Arguments
#   modelId: The id of the model containing the Mattertag to patch.
#   field: The id field to use, defaults to the primary identifier 
#   (id) but may also
#   be a secondary identifier if that id is only applied to a single model.
#   mattertagId: The id of the the Mattertag to patch.
#   type: The expected type of media at the given url.
#   url: The url to the media to retrieve.
updateMattertagMediaUrl(
modelId: ID!,
field: ModelIdField,
mattertagId: ID!,
type: MattertagMediaType,
url: String!
): Mattertag! 
#   Removes any media associated with the Mattertag.
# 
#   @error not.found: If no model with the given id exists.
#   @error not.unique: If multiple models with the given id exist for this 
#   organization. Note this only applies
#  
#   when searching on a `field` other than `id`
# 
# Arguments
#   modelId: The id of the model containing the Mattertag to patch.
#   field: The id field to use, defaults to the primary identifier 
#   (id) but may also
#   be a secondary identifier if that id is only applied to a single model.
#   mattertagId: The id of the the Mattertag to patch.
removeMattertagMedia(
modelId: ID!,
field: ModelIdField,
mattertagId: ID!
): Mattertag! 
#   Deletes the given Mattertag.
#   This call will always return true unless an unexpected error is encountered.
# 
#   @error not.found: If no model with the given id exists.  Note this will not 
#   happen if the
#  
#   mattertag does not exist as delete is idempotent, so attempting to delete a 
#   non-existent mattertag
#  
#   is ok.
#   @error not.unique: If multiple models with the given id exist for this 
#   organization. Note this only applies
#  
#   when searching on a `field` other than `id`
# 
# Arguments
#   modelId: The id of the model containing the Mattertag to patch.
#   field: The id field to use, defaults to the primary identifier 
#   (id) but may also
#   be a secondary identifier if that id is only applied to a single model.
#   mattertagId: The id of the the Mattertag to patch.
deleteMattertag(modelId: ID!, field: ModelIdField, mattertagId: ID!): Boolean! 
#   Unlocks the given bundle, ordering assets or
#   publishing resources as needed.
#   This call may result in charges to your account depending on your subscription.
#   Success of the call means that the operation has been "approved",
#   there may be additional time required for the associated asset
#   to be generated.
# 
# Arguments
#   id: The id of the model to retrieve.
#   field: The id field to use when fetching the model.
#   Default: id
#   bundleId: The id of the bundle to unlock.
#   options: Additional options to use when unlocking the bundle.
#   Query `model(id, field) { bundle(bundleId) { supportedOptions } }` to get
#   any additional unlock options that are available.
unlockModelBundle(
id: ID!,
field: ModelIdField,
bundleId: ID!,
options: UnlockOptions
): ModelBundle! 
}
Require by

This element is not required by anyone
Mutation

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
