Mutations

Use a GraphQL mutation to perform any kind of operation that changes data on the server. GraphQL mutations are comparable to POST, PUT, PATCH and DELETE requests in REST APIs. To form a mutation you must specify the mutation name, the input object and the output object. The required input object for each mutation is defined under its Arguments section and detailed under Inputs. The fields available for the output object are defined in the mutation's Type section, and are detailed under Objects. Each mutation costs 2,000 complexity points; a maximum of 5 mutations may be included in a single request.

Mutation categories

Mutations: Assets

GraphQL mutations for creating, updating, deleting, and publishing assets, folders, and repositories in the Amplience GraphQL Management API.

Mutations: Video transcoding

GraphQL mutations for adding, reprocessing, and removing video transcoding profiles in the Amplience GraphQL Management API.

Mutations: AI image tools

GraphQL mutations for AI-powered image generation, background removal, magic erase, caption generation, and shoppable image detection in the Amplience GraphQL Management API.

Mutations: Content generation

GraphQL mutations for content generation sessions, jobs, flows, and content review in the Amplience GraphQL Management API.

Teams & users

createTeam

Create new team

createTeam(
  input: CreateTeamInput!
): Team!

Returns: Team!

Arguments:

Argument	Type	Default	Description
input	CreateTeamInput!

updateTeam

Update an existing team

updateTeam(
  input: UpdateTeamInput!
): Team!

Returns: Team!

Arguments:

Argument	Type	Default	Description
input	UpdateTeamInput!

deleteTeam

delete an existing team

deleteTeam(
  input: DeleteTeamInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteTeamInput!

addTeamMember

Add members to Team

addTeamMember(
  input: AddTeamMembersInput!
): [User!]!

Returns: [User!]!

Arguments:

Argument	Type	Default	Description
input	AddTeamMembersInput!

removeTeamMember

Remove users from team

removeTeamMember(
  input: RemoveTeamMembersInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	RemoveTeamMembersInput!

inviteUserToOrganization

Invites a user to an organization

inviteUserToOrganization(
  input: InviteUserToOrganizationInput!
): Invitation!

Returns: Invitation!

Arguments:

Argument	Type	Default	Description
input	InviteUserToOrganizationInput!

updateOrganizationInvitation

Updates an organization invitation for a user

updateOrganizationInvitation(
  input: UpdateOrganizationInvitationInput!
): Invitation!

Returns: Invitation!

Arguments:

Argument	Type	Default	Description
input	UpdateOrganizationInvitationInput!

revokeOrganizationInvitation

Revokes an organization invitation

revokeOrganizationInvitation(
  input: RevokeOrganizationInvitationInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	RevokeOrganizationInvitationInput!

removeUserFromOrganization

Removes a user from an organization

removeUserFromOrganization(
  input: RemoveUserFromOrganizationInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	RemoveUserFromOrganizationInput!

assignOrganizationRoleToUser

Assign organization role to user

assignOrganizationRoleToUser(
  input: AssignOrganizationRoleToUserInput!
): OrganizationRolesUserAssignment!

Returns: OrganizationRolesUserAssignment!

Arguments:

Argument	Type	Default	Description
input	AssignOrganizationRoleToUserInput!

assignOrganizationRoleToTeam

Assign organization role to a team

assignOrganizationRoleToTeam(
  input: AssignOrganizationRoleToTeamInput!
): OrganizationRolesTeamAssignment!

Returns: OrganizationRolesTeamAssignment!

Arguments:

Argument	Type	Default	Description
input	AssignOrganizationRoleToTeamInput!

assignCMSHubRoleToUser

Assign hub role to user

assignCMSHubRoleToUser(
  input: AssignHubRoleToUserInput!
): CMSHubRolesUserAssignment!

Returns: CMSHubRolesUserAssignment!

Arguments:

Argument	Type	Default	Description
input	AssignHubRoleToUserInput!

assignCMSHubRoleToTeam

Assign hub role to a team

assignCMSHubRoleToTeam(
  input: AssignCMSHubRoleToTeamInput!
): CMSHubRolesTeamAssignment!

Returns: CMSHubRolesTeamAssignment!

Arguments:

Argument	Type	Default	Description
input	AssignCMSHubRoleToTeamInput!

assignCMSRepositoryRoleToUser

Assign CMS repository role to user

assignCMSRepositoryRoleToUser(
  input: AssignRepositoryRoleToUserInput!
): CMSRepositoryRolesUserAssignment!

Returns: CMSRepositoryRolesUserAssignment!

Arguments:

Argument	Type	Default	Description
input	AssignRepositoryRoleToUserInput!

assignCMSRepositoryRoleToTeam

Assign repository role to team

assignCMSRepositoryRoleToTeam(
  input: AssignCMSRepositoryRoleToTeamInput!
): CMSRepositoryRolesTeamAssignment!

Returns: CMSRepositoryRolesTeamAssignment!

Arguments:

Argument	Type	Default	Description
input	AssignCMSRepositoryRoleToTeamInput!

Personal access tokens

createPersonalAccessToken

See also: Examples: creating an access token

createPersonalAccessToken(
  input: CreatePersonalAccessTokenInput!
): PersonalAccessToken!

Returns: PersonalAccessToken!

Arguments:

Argument	Type	Default	Description
input	CreatePersonalAccessTokenInput!

requestPersonalAccessToken

requestPersonalAccessToken(
  input: CreatePersonalAccessTokenInput!
): PersonalAccessTokenRequest!

Returns: PersonalAccessTokenRequest!

Arguments:

Argument	Type	Default	Description
input	CreatePersonalAccessTokenInput!

approvePersonalAccessToken

approvePersonalAccessToken(
  input: UpdatePersonalAccessTokenInput!
): UpdatePersonalAccessTokenResponse!

Returns: UpdatePersonalAccessTokenResponse!

Arguments:

Argument	Type	Default	Description
input	UpdatePersonalAccessTokenInput!

deletePersonalAccessToken

See also: Examples: deleting an access token

deletePersonalAccessToken(
  input: DeletePersonalAccessTokenInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeletePersonalAccessTokenInput!

Transformation templates

createTransformationTemplate

Creates a new Transformation Template

See also: Examples: getting the media hub ID

createTransformationTemplate(
  input: CreateTransformationTemplateInput!
): TransformationTemplate!

Returns: TransformationTemplate!

Arguments:

Argument	Type	Default	Description
input	CreateTransformationTemplateInput!

updateTransformationTemplate

Updates a Transformation Template

updateTransformationTemplate(
  input: UpdateTransformationTemplateInput!
): TransformationTemplate!

Returns: TransformationTemplate!

Arguments:

Argument	Type	Default	Description
input	UpdateTransformationTemplateInput!

publishTransformationTemplate

Publishes a Transformation Template

publishTransformationTemplate(
  input: PublishTransformationTemplateInput!
): TransformationTemplate!

Returns: TransformationTemplate!

Arguments:

Argument	Type	Default	Description
input	PublishTransformationTemplateInput!

deleteTransformationTemplate

Deletes a Transformation Template

deleteTransformationTemplate(
  input: DeleteTransformationTemplateInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteTransformationTemplateInput!

Webhooks

createWebhookListener

createWebhookListener(
  input: CreateWebhookListenerInput!
): WebhookListener!

Returns: WebhookListener!

Arguments:

Argument	Type	Default	Description
input	CreateWebhookListenerInput!

updateWebhookListener

updateWebhookListener(
  input: UpdateWebhookListenerInput!
): WebhookListener!

Returns: WebhookListener!

Arguments:

Argument	Type	Default	Description
input	UpdateWebhookListenerInput!

deleteWebhookListener

deleteWebhookListener(
  input: DeleteWebhookListenerInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteWebhookListenerInput!

Preview keys

createPreviewKey

createPreviewKey(
  input: CreatePreviewKeyInput
): CreatePreviewKeyResponse

Returns: CreatePreviewKeyResponse

Arguments:

Argument	Type	Default	Description
input	CreatePreviewKeyInput

updatePreviewKey

updatePreviewKey(
  input: UpdatePreviewKeyInput
): PreviewKey

Returns: PreviewKey

Arguments:

Argument	Type	Default	Description
input	UpdatePreviewKeyInput

deletePreviewKey

deletePreviewKey(
  input: DeletePreviewKeyInput
): Boolean

Returns: Boolean

Arguments:

Argument	Type	Default	Description
input	DeletePreviewKeyInput

Temp file upload

createTempFileUploadUrl

See also: Temporary file service

createTempFileUploadUrl: CreateTempFileUploadUrlResponse!

Returns: CreateTempFileUploadUrlResponse!

createTempFileMultipartUploadUrl

See also: Temporary file service

createTempFileMultipartUploadUrl(
  input: CreateTempFileMultipartUploadUrlInput!
): CreateTempFileMultipartUploadUrlResponse!

Returns: CreateTempFileMultipartUploadUrlResponse!

Arguments:

Argument	Type	Default	Description
input	CreateTempFileMultipartUploadUrlInput!

Commerce repositories

createBigCommerceCommerceRepository

createBigCommerceCommerceRepository(
  input: CreateBigCommerceCommerceRepositoryInput!
): BigCommerceCommerceRepository!

Returns: BigCommerceCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	CreateBigCommerceCommerceRepositoryInput!

updateBigCommerceCommerceRepository

updateBigCommerceCommerceRepository(
  input: UpdateBigCommerceCommerceRepositoryInput!
): BigCommerceCommerceRepository!

Returns: BigCommerceCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	UpdateBigCommerceCommerceRepositoryInput!

createShopifyCommerceRepository

createShopifyCommerceRepository(
  input: CreateShopifyCommerceRepositoryInput!
): ShopifyCommerceRepository!

Returns: ShopifyCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	CreateShopifyCommerceRepositoryInput!

updateShopifyCommerceRepository

updateShopifyCommerceRepository(
  input: UpdateShopifyCommerceRepositoryInput!
): ShopifyCommerceRepository!

Returns: ShopifyCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	UpdateShopifyCommerceRepositoryInput!

createSalesforceCommerceRepository

createSalesforceCommerceRepository(
  input: CreateSalesforceCommerceRepositoryInput!
): SalesforceCommerceRepository!

Returns: SalesforceCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	CreateSalesforceCommerceRepositoryInput!

updateSalesforceCommerceRepository

updateSalesforceCommerceRepository(
  input: UpdateSalesforceCommerceRepositoryInput!
): SalesforceCommerceRepository!

Returns: SalesforceCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	UpdateSalesforceCommerceRepositoryInput!

createCommercetoolsCommerceRepository

createCommercetoolsCommerceRepository(
  input: CreateCommercetoolsCommerceRepositoryInput!
): CommercetoolsCommerceRepository!

Returns: CommercetoolsCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	CreateCommercetoolsCommerceRepositoryInput!

updateCommercetoolsCommerceRepository

updateCommercetoolsCommerceRepository(
  input: UpdateCommercetoolsCommerceRepositoryInput!
): CommercetoolsCommerceRepository!

Returns: CommercetoolsCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	UpdateCommercetoolsCommerceRepositoryInput!

createScayleCommerceRepository

createScayleCommerceRepository(
  input: CreateScayleCommerceRepositoryInput!
): ScayleCommerceRepository!

Returns: ScayleCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	CreateScayleCommerceRepositoryInput!

updateScayleCommerceRepository

updateScayleCommerceRepository(
  input: UpdateScayleCommerceRepositoryInput!
): ScayleCommerceRepository!

Returns: ScayleCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	UpdateScayleCommerceRepositoryInput!

createJsonFileFeedCommerceRepository

createJsonFileFeedCommerceRepository(
  input: CreateJsonFileFeedCommerceRepositoryInput!
): JsonFileFeedCommerceRepository!

Returns: JsonFileFeedCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	CreateJsonFileFeedCommerceRepositoryInput!

updateJsonFileFeedCommerceRepository

updateJsonFileFeedCommerceRepository(
  input: UpdateJsonFileFeedCommerceRepositoryInput!
): JsonFileFeedCommerceRepository!

Returns: JsonFileFeedCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	UpdateJsonFileFeedCommerceRepositoryInput!

createXmlFileFeedCommerceRepository

createXmlFileFeedCommerceRepository(
  input: CreateXmlFileFeedCommerceRepositoryInput!
): XmlFileFeedCommerceRepository!

Returns: XmlFileFeedCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	CreateXmlFileFeedCommerceRepositoryInput!

updateXmlFileFeedCommerceRepository

updateXmlFileFeedCommerceRepository(
  input: UpdateXmlFileFeedCommerceRepositoryInput!
): XmlFileFeedCommerceRepository!

Returns: XmlFileFeedCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	UpdateXmlFileFeedCommerceRepositoryInput!

createCsvFileFeedCommerceRepository

createCsvFileFeedCommerceRepository(
  input: CreateCsvFileFeedCommerceRepositoryInput!
): CsvFileFeedCommerceRepository!

Returns: CsvFileFeedCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	CreateCsvFileFeedCommerceRepositoryInput!

updateCsvFileFeedCommerceRepository

updateCsvFileFeedCommerceRepository(
  input: UpdateCsvFileFeedCommerceRepositoryInput!
): CsvFileFeedCommerceRepository!

Returns: CsvFileFeedCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	UpdateCsvFileFeedCommerceRepositoryInput!

createGoogleProductFeedCommerceRepository

createGoogleProductFeedCommerceRepository(
  input: CreateGoogleProductFeedCommerceRepositoryInput!
): GoogleProductFeedCommerceRepository!

Returns: GoogleProductFeedCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	CreateGoogleProductFeedCommerceRepositoryInput!

updateGoogleProductFeedCommerceRepository

updateGoogleProductFeedCommerceRepository(
  input: UpdateGoogleProductFeedCommerceRepositoryInput!
): GoogleProductFeedCommerceRepository!

Returns: GoogleProductFeedCommerceRepository!

Arguments:

Argument	Type	Default	Description
input	UpdateGoogleProductFeedCommerceRepositoryInput!

deleteCommerceRepository

deleteCommerceRepository(
  input: DeleteCommerceRepositoryInput
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteCommerceRepositoryInput

Extensions

createExtension

createExtension(
  input: CreateExtensionInput!
): Extension!

Returns: Extension!

Arguments:

Argument	Type	Default	Description
input	CreateExtensionInput!

updateExtension

updateExtension(
  input: UpdateExtensionInput!
): Extension!

Returns: Extension!

Arguments:

Argument	Type	Default	Description
input	UpdateExtensionInput!

deleteExtension

deleteExtension(
  input: DeleteExtensionInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteExtensionInput!

createExtensionRelease

createExtensionRelease(
  input: CreateExtensionReleaseInput!
): ExtensionRelease!

Returns: ExtensionRelease!

Arguments:

Argument	Type	Default	Description
input	CreateExtensionReleaseInput!

updateExtensionRelease

updateExtensionRelease(
  input: UpdateExtensionReleaseInput!
): ExtensionRelease!

Returns: ExtensionRelease!

Arguments:

Argument	Type	Default	Description
input	UpdateExtensionReleaseInput!

deleteExtensionRelease

deleteExtensionRelease(
  input: DeleteExtensionReleaseInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteExtensionReleaseInput!

createExtensionInstance

createExtensionInstance(
  input: CreateExtensionInstanceInput!
): ExtensionInstance!

Returns: ExtensionInstance!

Arguments:

Argument	Type	Default	Description
input	CreateExtensionInstanceInput!

updateExtensionInstance

updateExtensionInstance(
  input: UpdateExtensionInstanceInput!
): ExtensionInstance!

Returns: ExtensionInstance!

Arguments:

Argument	Type	Default	Description
input	UpdateExtensionInstanceInput!

deleteExtensionInstance

deleteExtensionInstance(
  input: DeleteExtensionInstanceInput!
): Boolean!

Returns: Boolean!

Arguments:

Argument	Type	Default	Description
input	DeleteExtensionInstanceInput!